com.filenet.api.constants
Class PermissionType

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

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

Specifies the type of permission.

See Also:
Serialized Form

Field Summary
static PermissionType LEVEL
          The permission is an access level (a commonly used combination of access rights).
static int LEVEL_AS_INT
          An int value associated with the LEVEL instance of this class.
static PermissionType LEVEL_DEFAULT
          The permission is the recommended default for new permissions.
static int LEVEL_DEFAULT_AS_INT
          An int value associated with the LEVEL_DEFAULT instance of this class.
static PermissionType RIGHT
          The permission is a single access right.
static int RIGHT_AS_INT
          An int value associated with the RIGHT instance of this class.
static PermissionType RIGHT_INHERIT_ONLY
          The permission is an access right that is only relevant to the child objects of the object described by the permission.
static int RIGHT_INHERIT_ONLY_AS_INT
          An int value associated with the RIGHT_INHERIT_ONLY instance of this class.
 
Method Summary
static PermissionType 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

LEVEL_DEFAULT_AS_INT

public static final int LEVEL_DEFAULT_AS_INT
An int value associated with the LEVEL_DEFAULT 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

LEVEL_DEFAULT

public static final PermissionType LEVEL_DEFAULT
The permission is the recommended default for new permissions.


RIGHT_INHERIT_ONLY_AS_INT

public static final int RIGHT_INHERIT_ONLY_AS_INT
An int value associated with the RIGHT_INHERIT_ONLY 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

RIGHT_INHERIT_ONLY

public static final PermissionType RIGHT_INHERIT_ONLY
The permission is an access right that is only relevant to the child objects of the object described by the permission.


RIGHT_AS_INT

public static final int RIGHT_AS_INT
An int value associated with the RIGHT 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

RIGHT

public static final PermissionType RIGHT
The permission is a single access right.


LEVEL_AS_INT

public static final int LEVEL_AS_INT
An int value associated with the LEVEL 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

LEVEL

public static final PermissionType LEVEL
The permission is an access level (a commonly used combination of access rights).

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 PermissionType 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.