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

Class UserAttributeSort

java.lang.Object

com.atlassian.confluence.search.v2.sort.UserAttributeSort

All Implemented Interfaces:

Expandable<SearchSort>, SearchSort

@SearchPrimitive
@Deprecated(forRemoval=true)
public final class UserAttributeSort
extends Object
implements SearchSort

Deprecated, for removal: This API element is subject to removal in a future version.

since 8.9 because it's very inefficient on Lucene, and is not supported on OpenSearch.

A base user sort that allows userkey fields to be sorted on either UserKey, Username, Full name or Email.

This class is a copy of BaseUserSort from confluence-cql-plugin inorder to deprecate the former one.

Since:

7.12

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	UserAttributeSort.UserAttribute	Deprecated, for removal: This API element is subject to removal in a future version.

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 final String	KEY	Deprecated, for removal: This API element is subject to removal in a future version.

Constructor Summary

Constructors

Constructor	Description
UserAttributeSort(UserAttributeSort.UserAttribute attribute, SearchSort.Order order, String fieldName)	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Deprecated, for removal: This API element is subject to removal in a future version.
UserAttributeSort.UserAttribute	getAttribute()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getFieldName()	Deprecated, for removal: This API element is subject to removal in a future version.
String	getKey()	Deprecated, for removal: This API element is subject to removal in a future version. Gets the key that uniquely identifies this sort method.
SearchSort.Order	getOrder()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the order (whether SearchSort.Order.ASCENDING or SearchSort.Order.DESCENDING) of the sort.
int	hashCode()	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class java.lang.Object

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

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

expand

Field Details

KEY

public static final String KEY

Deprecated, for removal: This API element is subject to removal in a future version.

See Also:

• Constant Field Values

Constructor Details

UserAttributeSort

public UserAttributeSort(UserAttributeSort.UserAttribute attribute,
 SearchSort.Order order,
 String fieldName)

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

getKey

public String getKey()

Deprecated, for removal: This API element is subject to removal in a future version.

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()

Deprecated, for removal: This API element is subject to removal in a future version.

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.

getFieldName

public String getFieldName()

Deprecated, for removal: This API element is subject to removal in a future version.

getAttribute

public UserAttributeSort.UserAttribute getAttribute()

Deprecated, for removal: This API element is subject to removal in a future version.

equals

public boolean equals(Object o)

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated, for removal: This API element is subject to removal in a future version.

Overrides:

hashCode in class Object