|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.constants.PrincipalSearchSortType
public class PrincipalSearchSortType
Determines which (if any) sorting is applied to the results of a specified search pattern. This class is used by
Realm.findUsers
and Realm.findGroups
.
Realm
,
PrincipalSearchType
,
PrincipalSearchAttribute
,
SQL Syntax Reference,
Serialized FormField Summary | |
---|---|
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 | |
---|---|
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int NONE_AS_INT
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.
public static final PrincipalSearchSortType NONE
getValue()
,
getInstanceFromInt(int)
public static final int ASCENDING_AS_INT
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.
public static final PrincipalSearchSortType ASCENDING
getValue()
,
getInstanceFromInt(int)
public static final int DESCENDING_AS_INT
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.
public static final PrincipalSearchSortType DESCENDING
getValue()
,
getInstanceFromInt(int)
Method Detail |
---|
public int getValue()
public static PrincipalSearchSortType getInstanceFromInt(int value)
value
- An integer representing a particular static instance of this class.
EngineRuntimeException
- Thrown when the parameter is null or invalid.public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |