com.filenet.api.constants
Class SecurityPrincipalType

java.lang.Object
  extended by com.filenet.api.constants.SecurityPrincipalType
All Implemented Interfaces:
java.io.Serializable

public final class SecurityPrincipalType
extends java.lang.Object
implements java.io.Serializable

Identifies the type of the security principal--either a Group or User object.

See Also:
Serialized Form

Field Summary
static SecurityPrincipalType GROUP
          The security principal type is a Group object.
static int GROUP_AS_INT
          An int value associated with the GROUP instance of this class.
static SecurityPrincipalType UNKNOWN
           
static int UNKNOWN_AS_INT
          An int value associated with the UNKNOWN instance of this class.
static SecurityPrincipalType USER
          The security principal type is a User object.
static int USER_AS_INT
          An int value associated with the USER instance of this class.
 
Method Summary
static SecurityPrincipalType getInstanceFromInt(int value)
          Returns an instance of this class using its associated integer value.
 int getValue()
          Returns the internal integer value associated with a specific instance of this class.
 java.lang.String toString()
          Returns a String representation of this enumeration instance.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

UNKNOWN_AS_INT

public static final int UNKNOWN_AS_INT
An int value associated with the UNKNOWN instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

UNKNOWN

public static final SecurityPrincipalType UNKNOWN

USER_AS_INT

public static final int USER_AS_INT
An int value associated with the USER instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

USER

public static final SecurityPrincipalType USER
The security principal type is a User object.


GROUP_AS_INT

public static final int GROUP_AS_INT
An int value associated with the GROUP instance of this class. Consider using the static instances of this class instead of the associated int values. The int values risk binary incompatibility (but not source incompatibility) from release to release.

See Also:
Constant Field Values

GROUP

public static final SecurityPrincipalType GROUP
The security principal type is a Group object.

Method Detail

getValue

public int getValue()
Returns the internal integer value associated with a specific instance of this class.

Returns:
The enumeration instance's ordinal value.
See Also:
getInstanceFromInt(int)

toString

public java.lang.String toString()
Returns a String representation of this enumeration instance.

Overrides:
toString in class java.lang.Object
Returns:
The enumeration instance's description.

getInstanceFromInt

public static SecurityPrincipalType getInstanceFromInt(int value)
Returns an instance of this class using its associated integer value.

Parameters:
value - The integer value. (See the *_AS_INT fields.)
Returns:
The enumeration instance with the given ordinal value.
Throws:
EngineRuntimeException - If an enumeration instance with the given ordinal value does not exist.
See Also:
getValue()


© Copyright IBM Corporation 2006, 2008. All rights reserved.