Package com.atlassian.confluence.search.v2.sort

Class FieldSort

java.lang.Object

com.atlassian.confluence.search.v2.sort.FieldSort

All Implemented Interfaces:

Expandable<SearchSort>, SearchSort

@SearchPrimitive
public final class FieldSort
extends Object
implements SearchSort

Sort based on value of a field.

Since:

7.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.confluence.search.v2.SearchSort

SearchSort.Order, SearchSort.Type

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY

Constructor Summary

Constructors

Constructor	Description
FieldSort(String fieldName, SearchSort.Type type, SearchSort.Order order)

Method Summary

Modifier and Type	Method	Description
String	getFieldName()
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.
SearchSort.Type	getType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.atlassian.confluence.search.v2.SearchSort

expand

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

FieldSort

public FieldSort(String fieldName,
                 SearchSort.Type type,
                 SearchSort.Order order)

Method Detail

getKey

public String getKey()

Description copied from interface: SearchSort

Gets the key that uniquely identifies this sort method.

Specified by:

getKey in interface SearchSort

Returns:

the sort key

getOrder

public SearchSort.Order getOrder()

Description copied from interface: SearchSort

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

Specified by:

getOrder in interface SearchSort

Returns:

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

getType

public SearchSort.Type getType()

getFieldName

public String getFieldName()