com.filenet.api.constants
Class PrincipalSearchSortType
- java.lang.Object
-
- com.filenet.api.constants.PrincipalSearchSortType
-
- All Implemented Interfaces:
- java.io.Serializable
public class PrincipalSearchSortType extends java.lang.Object implements java.io.Serializable
Determines which (if any) sorting is applied to the results of a specified search pattern. This class is used byRealm.findUsers
andRealm.findGroups
.
-
-
Field Summary
Fields Modifier and Type Field and Description static PrincipalSearchSortType
ASCENDING
A constant representing a PrincipalSearchSortType instance of type ASCENDING.static int
ASCENDING_AS_INT
An integer associated with the ASCENDING instance of this class.static PrincipalSearchSortType
DESCENDING
A constant representing a PrincipalSearchSortType instance of type DESCENDING.static int
DESCENDING_AS_INT
An integer associated with the DESCENDING instance of this class.static PrincipalSearchSortType
NONE
A constant representing a PrincipalSearchSortType instance of type NONE.static int
NONE_AS_INT
An integer associated with the NONE instance of this class.
-
Method Summary
Methods Modifier and Type Method and Description static PrincipalSearchSortType
getInstanceFromInt(int value)
Gets the instance of this class using its associated integer value (the *_AS_INT fields).int
getValue()
Returns an integer value associated with a specific instance of this class.java.lang.String
toString()
Returns a String representation of this instance.
-
-
-
Field Detail
-
NONE_AS_INT
public static final int NONE_AS_INT
An integer associated with the NONE instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
NONE
public static final PrincipalSearchSortType NONE
A constant representing a PrincipalSearchSortType instance of type NONE. This specifies that the search pattern results are not sorted.- See Also:
getValue()
,getInstanceFromInt(int)
-
ASCENDING_AS_INT
public static final int ASCENDING_AS_INT
An integer associated with the ASCENDING instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
ASCENDING
public static final PrincipalSearchSortType ASCENDING
A constant representing a PrincipalSearchSortType instance of type ASCENDING. This specifies that the search pattern results are sorted in ascending order.- See Also:
getValue()
,getInstanceFromInt(int)
-
DESCENDING_AS_INT
public static final int DESCENDING_AS_INT
An integer associated with the DESCENDING instance of this class.Use the static instances of this class, rather than the associated integer values. The integer values risk binary incompatibility (but not source incompatibility) across product releases.
- See Also:
- Constant Field Values
-
DESCENDING
public static final PrincipalSearchSortType DESCENDING
A constant representing a PrincipalSearchSortType instance of type DESCENDING. This specifies that the search pattern results are sorted in descending order.- See Also:
getValue()
,getInstanceFromInt(int)
-
-
Method Detail
-
getValue
public int getValue()
Returns an integer value associated with a specific instance of this class.- Returns:
- An integer representing a specific instance of this class.
-
getInstanceFromInt
public static PrincipalSearchSortType getInstanceFromInt(int value)
Gets the instance of this class using its associated integer value (the *_AS_INT fields).- Parameters:
value
- An integer representing a particular static instance of this class.- Returns:
- The PrincipalSearchSortType instance referenced.
- Throws:
EngineRuntimeException
- Thrown when the parameter is null or invalid.
-
toString
public java.lang.String toString()
Returns a String representation of this instance.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A String representing the instance.
-
-