com.filenet.api.constants
Class PermissionSource

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

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

Specifies the source of a given access permission.

See Also:
Serialized Form

Field Summary
static PermissionSource MARKING
          Deprecated. As of release 4.0.1.
static int MARKING_AS_INT
          Deprecated.  
static PermissionSource PROXY
          Specifies that the permission is from a security proxy object.
static int PROXY_AS_INT
          An int value associated with the PROXY instance of this class.
static PermissionSource SOURCE_DEFAULT
          Specifies that the permission is a default permission.
static int SOURCE_DEFAULT_AS_INT
          An int value associated with the SOURCE_DEFAULT instance of this class.
static PermissionSource SOURCE_DIRECT
          Specifies that the permission is added directly to object.
static int SOURCE_DIRECT_AS_INT
          An int value associated with the SOURCE_DIRECT instance of this class.
static PermissionSource SOURCE_PARENT
          Specifies that the permission is inherited from a security parent.
static int SOURCE_PARENT_AS_INT
          An int value associated with the SOURCE_PARENT instance of this class.
static PermissionSource SOURCE_TEMPLATE
          Specifies that the permission is from a security template.
static int SOURCE_TEMPLATE_AS_INT
          An int value associated with the SOURCE_TEMPLATE instance of this class.
 
Method Summary
static PermissionSource 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

SOURCE_TEMPLATE_AS_INT

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

SOURCE_TEMPLATE

public static final PermissionSource SOURCE_TEMPLATE
Specifies that the permission is from a security template.


SOURCE_PARENT_AS_INT

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

SOURCE_PARENT

public static final PermissionSource SOURCE_PARENT
Specifies that the permission is inherited from a security parent.


SOURCE_DEFAULT_AS_INT

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

SOURCE_DEFAULT

public static final PermissionSource SOURCE_DEFAULT
Specifies that the permission is a default permission.


SOURCE_DIRECT_AS_INT

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

SOURCE_DIRECT

public static final PermissionSource SOURCE_DIRECT
Specifies that the permission is added directly to object.


MARKING_AS_INT

public static final int MARKING_AS_INT
Deprecated. 
See Also:
Constant Field Values

MARKING

public static final PermissionSource MARKING
Deprecated. As of release 4.0.1.
Specifies that the permission is from a Marking property.


PROXY_AS_INT

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

PROXY

public static final PermissionSource PROXY
Specifies that the permission is from a security proxy object. Permissions originating from a security proxy are returned in order of precedence.

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 PermissionSource 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, 2009. All rights reserved.