Class SortInfo
java.lang.Object
com.appiancorp.suiteapi.common.paging.SortInfo
- All Implemented Interfaces:
ReadOnlySortInfo
,Serializable
@Entity
@GwtCompatible
public final class SortInfo
extends Object
implements ReadOnlySortInfo, Serializable
This class is available as a preview of functionality that will be added to
the supported public API in a future release. While it is in the preview
phase, it is subject to change or removal without deprecation or notice.
Although notice of change is not guaranteed, we will try to let developers
know of major changes through announcements in release notes.
This class is used as an argument for functions that sort a data set.
- See Also:
-
Field Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic SortInfo
Convenience method for returning a SortInfo with ascending sort.static SortInfo
Convenience method for returning a SortInfo with descending sort.boolean
Returns a boolean value indicating whether the given object is equal to this object.static com.google.common.base.Predicate<SortInfo>
fieldEqualsPredicate
(String targetFieldName) getField()
Returns the field to sort by.int
hashCode()
Returns a hash code value for the object.boolean
Returns a boolean indicating whether sort ongetField()
should be in ascending or descending order.toString()
Returns a string representation of theSortInfo
-
Field Details
-
FIELD_FIELD_NAME
- See Also:
-
ASCENDING_FIELD_NAME
- See Also:
-
TABLE_NAME
- See Also:
-
LOCAL_PART
- See Also:
-
QNAME
-
-
Constructor Details
-
SortInfo
public SortInfo()Should not be used, only exposed for serializers that require a public parameterless constructor. -
SortInfo
- Parameters:
field
- the field to sort by. May be a simple field name, or dot notation to specify a subfield (e.g., "complexField.subField")ascending
- if true, indicates that the sort ongetField()
should be in ascending order. If false, indicates that the sort should be in descending order.
-
-
Method Details
-
getField
Returns the field to sort by. May be a simple field name, or dot notation to specify a subfield (e.g., "complexField.subField")- Specified by:
getField
in interfaceReadOnlySortInfo
-
isAscending
public boolean isAscending()Returns a boolean indicating whether sort ongetField()
should be in ascending or descending order. If true, indicates that the sort should be in ascending order. If false, indicates that the sort should be in descending order.- Specified by:
isAscending
in interfaceReadOnlySortInfo
-
asc
Convenience method for returning a SortInfo with ascending sort. -
desc
Convenience method for returning a SortInfo with descending sort. -
toString
Returns a string representation of theSortInfo
-
hashCode
public int hashCode()Returns a hash code value for the object. -
equals
Returns a boolean value indicating whether the given object is equal to this object. -
fieldEqualsPredicate
-