|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.api.constants.PrincipalSearchAttribute
public class PrincipalSearchAttribute
Determines which (if any) identifying attribute is used for a specified search pattern. This class is used by
Realm.findUsers
and Realm.findGroups
.
Realm
,
PrincipalSearchType
,
PrincipalSearchSortType
,
SQL Syntax Reference,
Serialized FormField Summary | |
---|---|
static PrincipalSearchAttribute |
DISPLAY_NAME
A constant representing a PrincipalSearchAttribute instance of type DISPLAY_NAME. |
static int |
DISPLAY_NAME_AS_INT
An integer associated with the DISPLAY_NAME instance of this class. |
static PrincipalSearchAttribute |
NONE
A constant representing a PrincipalSearchAttribute instance of type NONE. |
static int |
NONE_AS_INT
An integer associated with the NONE instance of this class. |
static PrincipalSearchAttribute |
SHORT_NAME
A constant representing a PrincipalSearchAttribute instance of type SHORT_NAME. |
static int |
SHORT_NAME_AS_INT
An integer associated with the SHORT_NAME instance of this class. |
Method Summary | |
---|---|
static PrincipalSearchAttribute |
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 PrincipalSearchAttribute NONE
getValue()
,
getInstanceFromInt(int)
public static final int SHORT_NAME_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 PrincipalSearchAttribute SHORT_NAME
getValue()
,
getInstanceFromInt(int)
public static final int DISPLAY_NAME_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 PrincipalSearchAttribute DISPLAY_NAME
getValue()
,
getInstanceFromInt(int)
Method Detail |
---|
public int getValue()
public static PrincipalSearchAttribute 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 |