SearchSort (Atlassian Confluence 8.3.1-CONFSRVDEV-268640-m02 API)

All Superinterfaces:

Expandable<SearchSort>

All Known Implementing Classes:

AbstractSort, ContentIdSort, CreatedSort, FavouriteSort, FieldSort, FilenameSort, FilesizeSort, FullnameSort, LowercaseFieldSort, ModifiedSort, MultiSearchSort, RelevanceSort, TitleSort, UserAttributeSort
```
public interface SearchSort
extends Expandable<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 Description

static class SearchSort.Order
Enum defining the types of ordering supported.

static class SearchSort.Type

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default SearchSort`	`expand()`	Expand this query/filter into a composite query/filter (that composes others).
`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.
  - expand
```
default SearchSort expand()
```
    Description copied from interface: Expandable
    
    Expand this query/filter into a composite query/filter (that composes others).
    
    Specified by:
    
    expand in interface Expandable<SearchSort>
    
    Returns:
    
    a query/filter