com.atlassian.confluence.search.v2
Interface SearchSort

All Known Implementing Classes:

AbstractSort, CreatedSort, ModifiedSort, RelevanceSort

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 interface

SearchSort.Order The two most common sort orders are defined here as constants for convenience.

Method Summary

java.lang.String	getKey() Gets the key that uniquely identifies this sort method.
java.lang.String	getOrder() Gets a string describing what order the results will be sorted in.

Method Detail

getKey

java.lang.String getKey()

Gets the key that uniquely identifies this sort method.

Returns:

the sort key

getOrder

java.lang.String getOrder()

Gets a string describing what order the results will be sorted in. The most common two sort orders are SearchSort.Order.ASCENDING and SearchSort.Order.DESCENDING, but implementations may define other ordering options as necessary.

Returns:

a string representing the sort order