UserAttributeSort (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.search.v2.sort.UserAttributeSort

All Implemented Interfaces:

Expandable<SearchSort>, SearchSort
```
@SearchPrimitive
public final class UserAttributeSort
extends Object
implements SearchSort
```
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 class UserAttributeSort.UserAttribute
- 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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`UserAttributeSort.UserAttribute`	`getAttribute()`
`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.
`int`	`hashCode()`

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 Detail
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - UserAttributeSort
```
public UserAttributeSort(UserAttributeSort.UserAttribute attribute,
                         SearchSort.Order order,
                         String fieldName)
```
- 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.
  - getFieldName
```
public String getFieldName()
```
  - getAttribute
```
public UserAttributeSort.UserAttribute getAttribute()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object