com.filenet.api.constants
Class AccessRight

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

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

Provides a set of constants that identify individual permissions (access rights) that can be applied to an object. Access rights vary by object and control all operations on that type of object. A user's access to objects is controlled by the access rights awarded to the individual user, and by the access rights awarded to any group of which that user is a member. Access rights to individual objects are checked each time the user attempts to access an object from an object store.

See Also:
AccessLevel, Serialized Form

Field Summary
static AccessRight ADD_MARKING
          Specifies that the user or group is granted or denied permission to assign a Marking object to an object.
static int ADD_MARKING_AS_INT
          An int value associated with the ADD_MARKING instance of this class.
static AccessRight CHANGE_STATE
          Specifies that the user or group is granted or denied permission to change the lifecycle state of an object.
static int CHANGE_STATE_AS_INT
          An int value associated with the CHANGE_STATE instance of this class.
static AccessRight CONNECT
          Specifies that the user or group is granted or denied permission to connect to an object store.
static int CONNECT_AS_INT
          An int value associated with the CONNECT instance of this class.
static AccessRight CREATE_CHILD
          Specifies that the user or group is granted or denied permission to create a child object.
static int CREATE_CHILD_AS_INT
          An int value associated with the CREATE_CHILD instance of this class.
static AccessRight CREATE_INSTANCE
          Specifies that the user or group is granted or denied permission to create a new instance of an object.
static int CREATE_INSTANCE_AS_INT
          An int value associated with the CREATE_INSTANCE instance of this class.
static AccessRight DELETE
          Specifies that the user or group is granted or denied permission to delete an object.
static int DELETE_AS_INT
          An int value associated with the DELETE instance of this class.
static AccessRight LINK
          Specifies that the user or group is granted or denied permission to link to an object.
static int LINK_AS_INT
          An int value associated with the LINK instance of this class.
static AccessRight MAJOR_VERSION
          Specifies that the user or group is granted or denied permission to create a document major version.
static int MAJOR_VERSION_AS_INT
          An int value associated with the MAJOR_VERSION instance of this class.
static AccessRight MINOR_VERSION
          Specifies that the user or group is granted or denied permission to create a new document minor version.
static int MINOR_VERSION_AS_INT
          An int value associated with the MINOR_VERSION instance of this class.
static AccessRight MODIFY_OBJECTS
          Specifies that the user or group is granted or denied permission to modify objects in an object store.
static int MODIFY_OBJECTS_AS_INT
          An int value associated with the MODIFY_OBJECTS instance of this class.
static AccessRight NONE
          Specifies that the user or group has no access to objects.
static int NONE_AS_INT
          An int value associated with the NONE instance of this class.
static AccessRight PRIVILEGED_WRITE
          Specifies that the user or group is granted or denied permission to set certain system-level properties (Creator, DateCreated, LastModifier, DateLastModified).
static int PRIVILEGED_WRITE_AS_INT
          An int value associated with the PRIVILEGED_WRITE instance of this class.
static AccessRight PUBLISH
          Specifies that the user or group is granted or denied permission to publish an object.
static int PUBLISH_AS_INT
          An int value associated with the PUBLISH instance of this class.
static AccessRight READ
          Specifies that the user or group is granted or denied permission to view the properties of an object.
static AccessRight READ_ACL
          Specifies that the user or group is granted or denied permission to view an object's security (that is, its PermissionList collection).
static int READ_ACL_AS_INT
          An int value associated with the READ_ACL instance of this class.
static int READ_AS_INT
          An int value associated with the READ instance of this class.
static AccessRight REMOVE_MARKING
          Specifies that the user or group is granted or denied permission to remove a Marking object from an object.
static int REMOVE_MARKING_AS_INT
          An int value associated with the REMOVE_MARKING instance of this class.
static AccessRight REMOVE_OBJECTS
          Specifies that the user or group is granted or denied permission to delete objects in an object store.
static int REMOVE_OBJECTS_AS_INT
          An int value associated with the REMOVE_OBJECTS instance of this class.
static AccessRight RESERVED12
          Reserved.
static int RESERVED12_AS_INT
          An int value associated with the RESERVED12 instance of this class.
static AccessRight RESERVED13
          Reserved.
static int RESERVED13_AS_INT
          An int value associated with the RESERVED13 instance of this class.
static AccessRight STORE_OBJECTS
          Specifies that the user or group is granted or denied permission to create and store new objects in an object store.
static int STORE_OBJECTS_AS_INT
          An int value associated with the STORE_OBJECTS instance of this class.
static AccessRight UNLINK
          Specifies that the user or group is granted or denied permission to unlink from an object.
static int UNLINK_AS_INT
          An int value associated with the UNLINK instance of this class.
static AccessRight USE_MARKING
          Determines whether or not the constraint mask will be applied.
static int USE_MARKING_AS_INT
          An int value associated with the USE_MARKING instance of this class.
static AccessRight VIEW_CONTENT
          Specifies that the user or group is granted or denied permission to view the content of an object.
static int VIEW_CONTENT_AS_INT
          An int value associated with the VIEW_CONTENT instance of this class.
static AccessRight WRITE
          Specifies that the user or group is granted or denied permission to modify the properties of an object.
static AccessRight WRITE_ACL
          Specifies that the user or group is granted or denied permission to modify an object's security (that is, its PermissionList collection).
static int WRITE_ACL_AS_INT
          An int value associated with the WRITE_ACL instance of this class.
static AccessRight WRITE_ANY_OWNER
          Specifies that the user or group is granted or denied permission to change the ownership of an object to another user.
static int WRITE_ANY_OWNER_AS_INT
          An int value associated with the WRITE_ANY_OWNER instance of this class.
static int WRITE_AS_INT
          An int value associated with the WRITE instance of this class.
static AccessRight WRITE_OWNER
          Specifies that the user or group is granted or denied permission to assume the ownership of an object.
static int WRITE_OWNER_AS_INT
          An int value associated with the WRITE_OWNER instance of this class.
 
Method Summary
static AccessRight 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

DELETE_AS_INT

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

DELETE

public static final AccessRight DELETE
Specifies that the user or group is granted or denied permission to delete an object.


MODIFY_OBJECTS_AS_INT

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

MODIFY_OBJECTS

public static final AccessRight MODIFY_OBJECTS
Specifies that the user or group is granted or denied permission to modify objects in an object store.


NONE_AS_INT

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

NONE

public static final AccessRight NONE
Specifies that the user or group has no access to objects.


UNLINK_AS_INT

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

UNLINK

public static final AccessRight UNLINK
Specifies that the user or group is granted or denied permission to unlink from an object.


USE_MARKING_AS_INT

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

USE_MARKING

public static final AccessRight USE_MARKING
Determines whether or not the constraint mask will be applied. If a user has been denied the AccessRight.USE_MARKING access right, then the constraint mask is applied to the effective access mask that was computed by the authorization service.


LINK_AS_INT

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

LINK

public static final AccessRight LINK
Specifies that the user or group is granted or denied permission to link to an object.


WRITE_AS_INT

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

WRITE

public static final AccessRight WRITE
Specifies that the user or group is granted or denied permission to modify the properties of an object.


REMOVE_MARKING_AS_INT

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

REMOVE_MARKING

public static final AccessRight REMOVE_MARKING
Specifies that the user or group is granted or denied permission to remove a Marking object from an object.


ADD_MARKING_AS_INT

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

ADD_MARKING

public static final AccessRight ADD_MARKING
Specifies that the user or group is granted or denied permission to assign a Marking object to an object.


PRIVILEGED_WRITE_AS_INT

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

PRIVILEGED_WRITE

public static final AccessRight PRIVILEGED_WRITE
Specifies that the user or group is granted or denied permission to set certain system-level properties (Creator, DateCreated, LastModifier, DateLastModified).

This access right should be granted only to those users who run applications that require an elevated level of privilege on the Content Engine server. Examples of these are: import applications, which require the ability to preserve original user and date information (that is, the values of the above noted system properties) upon importing from the original repository; bulk entry applications; and migration applications.

NOTE: This access right should not be granted to ordinary users and groups or even to most administrators. It is not included in the full control level of object store access (AccessLevel.FULL_CONTROL_OBJECT_STORE).


PUBLISH_AS_INT

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

PUBLISH

public static final AccessRight PUBLISH
Specifies that the user or group is granted or denied permission to publish an object.


CONNECT_AS_INT

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

CONNECT

public static final AccessRight CONNECT
Specifies that the user or group is granted or denied permission to connect to an object store.


MINOR_VERSION_AS_INT

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

MINOR_VERSION

public static final AccessRight MINOR_VERSION
Specifies that the user or group is granted or denied permission to create a new document minor version.


WRITE_ACL_AS_INT

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

WRITE_ACL

public static final AccessRight WRITE_ACL
Specifies that the user or group is granted or denied permission to modify an object's security (that is, its PermissionList collection).


WRITE_ANY_OWNER_AS_INT

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

WRITE_ANY_OWNER

public static final AccessRight WRITE_ANY_OWNER
Specifies that the user or group is granted or denied permission to change the ownership of an object to another user. If a user or group has been granted WRITE_ANY_OWNER permission on an ObjectStore object, then that user or group is also automatically granted the WRITE_OWNER permission on all objects contained in that object store.


READ_ACL_AS_INT

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

READ_ACL

public static final AccessRight READ_ACL
Specifies that the user or group is granted or denied permission to view an object's security (that is, its PermissionList collection).


CREATE_CHILD_AS_INT

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

CREATE_CHILD

public static final AccessRight CREATE_CHILD
Specifies that the user or group is granted or denied permission to create a child object.


CHANGE_STATE_AS_INT

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

CHANGE_STATE

public static final AccessRight CHANGE_STATE
Specifies that the user or group is granted or denied permission to change the lifecycle state of an object.


RESERVED13_AS_INT

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

RESERVED13

public static final AccessRight RESERVED13
Reserved.


VIEW_CONTENT_AS_INT

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

VIEW_CONTENT

public static final AccessRight VIEW_CONTENT
Specifies that the user or group is granted or denied permission to view the content of an object.


RESERVED12_AS_INT

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

RESERVED12

public static final AccessRight RESERVED12
Reserved.


MAJOR_VERSION_AS_INT

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

MAJOR_VERSION

public static final AccessRight MAJOR_VERSION
Specifies that the user or group is granted or denied permission to create a document major version.


REMOVE_OBJECTS_AS_INT

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

REMOVE_OBJECTS

public static final AccessRight REMOVE_OBJECTS
Specifies that the user or group is granted or denied permission to delete objects in an object store.


STORE_OBJECTS_AS_INT

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

STORE_OBJECTS

public static final AccessRight STORE_OBJECTS
Specifies that the user or group is granted or denied permission to create and store new objects in an object store.


WRITE_OWNER_AS_INT

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

WRITE_OWNER

public static final AccessRight WRITE_OWNER
Specifies that the user or group is granted or denied permission to assume the ownership of an object.


CREATE_INSTANCE_AS_INT

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

CREATE_INSTANCE

public static final AccessRight CREATE_INSTANCE
Specifies that the user or group is granted or denied permission to create a new instance of an object.


READ_AS_INT

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

READ

public static final AccessRight READ
Specifies that the user or group is granted or denied permission to view the properties of an 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 AccessRight 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.