com.atlassian.confluence.search.v2
Interface SearchSort

All Known Implementing Classes:

AbstractSort, CreatedSort, ModifiedSort, RelevanceSort, TitleSort

public interface SearchSort

Represents some method for sorting search results, and the order in which to search them. Implementations should be immutable.

Nested Class Summary

static class

SearchSort.Order Enum defining the types of ordering supported.

Method Summary

java.lang.String	getKey() Gets the key that uniquely identifies this sort method.
SearchSort.Order	getOrder() Returns the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.

Method Detail

getKey

java.lang.String getKey()

Gets the key that uniquely identifies this sort method.

Returns:

the sort key

getOrder

SearchSort.Order getOrder()

Returns the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.

Returns:

the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.