com.atlassian.confluence.search.v2

Interface SearchSort

All Known Implementing Classes:

AbstractSort, ContentPropertyFieldSort, CreatedSort, FavouriteSort, FilenameSort, FilesizeSort, FullnameSort, 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

Nested Classes

Modifier and Type	Interface and Description
static class	SearchSort.Order Enum defining the types of ordering supported.

Method Summary

Modifier and Type	Method and Description
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

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.