com.filenet.api.constants

Class PrincipalSearchAttribute

java.lang.Object

com.filenet.api.constants.PrincipalSearchAttribute

All Implemented Interfaces:

java.io.Serializable

public class PrincipalSearchAttribute
extends java.lang.Object
implements java.io.Serializable

Determines which (if any) identifying attribute is used for a specified search pattern. This class is used by Realm.findUsers and Realm.findGroups.

See Also:

Realm, PrincipalSearchType, PrincipalSearchSortType, SQL Syntax Reference, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Modifier and Type	Method and Description
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

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 PrincipalSearchAttribute NONE

A constant representing a PrincipalSearchAttribute instance of type NONE. This specifies that no identifying attribute is used for the search pattern.

See Also:

getValue(), getInstanceFromInt(int)

SHORT_NAME_AS_INT

public static final int SHORT_NAME_AS_INT

An integer associated with the SHORT_NAME 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

SHORT_NAME

public static final PrincipalSearchAttribute SHORT_NAME

A constant representing a PrincipalSearchAttribute instance of type SHORT_NAME. This specifies that the short name is used for the search pattern.

See Also:

getValue(), getInstanceFromInt(int)

DISPLAY_NAME_AS_INT

public static final int DISPLAY_NAME_AS_INT

An integer associated with the DISPLAY_NAME 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

DISPLAY_NAME

public static final PrincipalSearchAttribute DISPLAY_NAME

A constant representing a PrincipalSearchAttribute instance of type DISPLAY_NAME. This specifies that the display name is used for the search pattern.

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 PrincipalSearchAttribute 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 PrincipalSearchAttribute 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 class java.lang.Object

Returns:

A String representing the instance.