Class AccessRight
- java.lang.Object
-
- com.filenet.api.constants.AccessRight
-
- All Implemented Interfaces:
- java.io.Serializable
public final class AccessRight extends java.lang.Object implements java.io.SerializableProvides 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 the 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.Use
AccessRightconstants to set and check permissions. To determine which access rights are required to perform common actions, see Access rights required to take actions.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field and Description static AccessRightADD_MARKINGSpecifies that the user or group is granted or denied permission to assign aMarkingobject to an object.static intADD_MARKING_AS_INTAnintvalue associated with the ADD_MARKING instance of this class.static AccessRightCHANGE_STATESpecifies that the user or group is granted or denied permission to change the lifecycle state of an object.static intCHANGE_STATE_AS_INTAnintvalue associated with the CHANGE_STATE instance of this class.static AccessRightCONNECTSpecifies that the user or group is granted or denied permission to connect to an object store.static intCONNECT_AS_INTAnintvalue associated with the CONNECT instance of this class.static AccessRightCREATE_CHILDSpecifies that the user or group is granted or denied permission to create a child object.static intCREATE_CHILD_AS_INTAnintvalue associated with the CREATE_CHILD instance of this class.static AccessRightCREATE_INSTANCESpecifies that the user or group is granted or denied permission to create a new instance of an object.static intCREATE_INSTANCE_AS_INTAnintvalue associated with the CREATE_INSTANCE instance of this class.static AccessRightDELEGATE_ACCESSSpecifies that the user or group is granted or denied permission to delegate rights to another user or group.static intDELEGATE_ACCESS_AS_INTAnintvalue associated with the DELEGATE_ACCESS instance of this class.static AccessRightDELETESpecifies that the user or group is granted or denied permission to delete an object.static intDELETE_AS_INTAnintvalue associated with the DELETE instance of this class.static AccessRightLINKSpecifies that the user or group is granted or denied permission to link to an object.static intLINK_AS_INTAnintvalue associated with the LINK instance of this class.static AccessRightMAJOR_VERSIONSpecifies that the user or group is granted or denied permission to create a document major version.static intMAJOR_VERSION_AS_INTAnintvalue associated with the MAJOR_VERSION instance of this class.static AccessRightMINOR_VERSIONSpecifies that the user or group is granted or denied permission to create a new document minor version.static intMINOR_VERSION_AS_INTAnintvalue associated with the MINOR_VERSION instance of this class.static AccessRightMODIFY_OBJECTSSpecifies that the user or group is granted or denied permission to modify objects in an object store.static intMODIFY_OBJECTS_AS_INTAnintvalue associated with the MODIFY_OBJECTS instance of this class.static AccessRightMODIFY_RETENTIONThis constant is not supported.static intMODIFY_RETENTION_AS_INTAnintvalue associated with the MODIFY_RETENTION instance of this class.static AccessRightNONESpecifies that the user or group has no access to objects.static intNONE_AS_INTAnintvalue associated with the NONE instance of this class.static AccessRightPRIVILEGED_WRITESpecifies that the user or group is granted or denied permission to set certain system-level properties (Creator,DateCreated,LastModifier,DateLastModified).static intPRIVILEGED_WRITE_AS_INTAnintvalue associated with the PRIVILEGED_WRITE instance of this class.static AccessRightPUBLISHSpecifies that the user or group is granted or denied permission to publish an object.static intPUBLISH_AS_INTAnintvalue associated with the PUBLISH instance of this class.static AccessRightREADSpecifies that the user or group is granted or denied permission to view the properties of an object.static AccessRightREAD_ACLSpecifies that the user or group is granted or denied permission to view an object's security (that is, its PermissionList collection).static intREAD_ACL_AS_INTAnintvalue associated with the READ_ACL instance of this class.static intREAD_AS_INTAnintvalue associated with the READ instance of this class.static AccessRightREMOVE_MARKINGSpecifies that the user or group is granted or denied permission to remove aMarkingobject from an object.static intREMOVE_MARKING_AS_INTAnintvalue associated with the REMOVE_MARKING instance of this class.static AccessRightREMOVE_OBJECTSSpecifies that the user or group is granted or denied permission to delete objects in an object store.static intREMOVE_OBJECTS_AS_INTAnintvalue associated with the REMOVE_OBJECTS instance of this class.static AccessRightRESERVED12Reserved.static intRESERVED12_AS_INTAnintvalue associated with the RESERVED12 instance of this class.static AccessRightRESERVED13Reserved.static intRESERVED13_AS_INTAnintvalue associated with the RESERVED13 instance of this class.static AccessRightSTORE_OBJECTSSpecifies that the user or group is granted or denied permission to create and store new objects in an object store.static intSTORE_OBJECTS_AS_INTAnintvalue associated with the STORE_OBJECTS instance of this class.static AccessRightUNLINKSpecifies that the user or group is granted or denied permission to unlink from an object.static intUNLINK_AS_INTAnintvalue associated with the UNLINK instance of this class.static AccessRightUSE_MARKINGDetermines whether or not the constraint mask will be applied.static intUSE_MARKING_AS_INTAnintvalue associated with the USE_MARKING instance of this class.static AccessRightVIEW_CONTENTSpecifies that the user or group is granted or denied permission to view the content of an object.static intVIEW_CONTENT_AS_INTAnintvalue associated with the VIEW_CONTENT instance of this class.static AccessRightVIEW_RECOVERABLE_OBJECTSSpecifies that the user or group is granted or denied permission to retrieve or query all recoverable objects in the object store.static intVIEW_RECOVERABLE_OBJECTS_AS_INTAnintvalue associated with the VIEW_RECOVERABLE_OBJECTS instance of this class.static AccessRightWRITESpecifies that the user or group is granted or denied permission to modify the properties of an object.static AccessRightWRITE_ACLSpecifies that the user or group is granted or denied permission to modify an object's security (that is, itsPermissionListcollection).static intWRITE_ACL_AS_INTAnintvalue associated with the WRITE_ACL instance of this class.static AccessRightWRITE_ANY_OWNERSpecifies that the user or group is granted or denied permission to change the ownership of an object to another user.static intWRITE_ANY_OWNER_AS_INTAnintvalue associated with the WRITE_ANY_OWNER instance of this class.static intWRITE_AS_INTAnintvalue associated with the WRITE instance of this class.static AccessRightWRITE_OWNERSpecifies that the user or group is granted or denied permission to assume the ownership of an object.static intWRITE_OWNER_AS_INTAnintvalue associated with the WRITE_OWNER instance of this class.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description static AccessRightgetInstanceFromInt(int value)Returns an instance of this class using its associated integer value.intgetValue()Returns the internal integer value associated with a specific instance of this class.java.lang.StringtoString()Returns aStringrepresentation of this enumeration instance.
-
-
-
Field Detail
-
READ_ACL_AS_INT
public static final int READ_ACL_AS_INT
Anintvalue 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).
-
WRITE_OWNER_AS_INT
public static final int WRITE_OWNER_AS_INT
Anintvalue 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. If grantedWRITE_OWNERpermission on an object, a user can set the Owner property to null or the user's own identity. To set the Owner property to any other non-null value requires theWRITE_ANY_OWNERpermission on the object store.
-
CHANGE_STATE_AS_INT
public static final int CHANGE_STATE_AS_INT
Anintvalue 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.
-
REMOVE_MARKING_AS_INT
public static final int REMOVE_MARKING_AS_INT
Anintvalue 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 aMarkingobject from an object.
-
STORE_OBJECTS_AS_INT
public static final int STORE_OBJECTS_AS_INT
Anintvalue 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.
-
CONNECT_AS_INT
public static final int CONNECT_AS_INT
Anintvalue 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.
-
PRIVILEGED_WRITE_AS_INT
public static final int PRIVILEGED_WRITE_AS_INT
Anintvalue 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.
-
WRITE_AS_INT
public static final int WRITE_AS_INT
Anintvalue 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.
-
DELETE_AS_INT
public static final int DELETE_AS_INT
Anintvalue 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.
-
REMOVE_OBJECTS_AS_INT
public static final int REMOVE_OBJECTS_AS_INT
Anintvalue 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.
-
MAJOR_VERSION_AS_INT
public static final int MAJOR_VERSION_AS_INT
Anintvalue 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.
-
RESERVED12_AS_INT
public static final int RESERVED12_AS_INT
Anintvalue 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.
-
LINK_AS_INT
public static final int LINK_AS_INT
Anintvalue 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.
-
RESERVED13_AS_INT
public static final int RESERVED13_AS_INT
Anintvalue 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.
-
NONE_AS_INT
public static final int NONE_AS_INT
Anintvalue 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.
-
CREATE_INSTANCE_AS_INT
public static final int CREATE_INSTANCE_AS_INT
Anintvalue 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.
-
DELEGATE_ACCESS_AS_INT
public static final int DELEGATE_ACCESS_AS_INT
Anintvalue associated with the DELEGATE_ACCESS 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
-
DELEGATE_ACCESS
public static final AccessRight DELEGATE_ACCESS
Specifies that the user or group is granted or denied permission to delegate rights to another user or group.
-
UNLINK_AS_INT
public static final int UNLINK_AS_INT
Anintvalue 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.
-
MINOR_VERSION_AS_INT
public static final int MINOR_VERSION_AS_INT
Anintvalue 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.
-
PUBLISH_AS_INT
public static final int PUBLISH_AS_INT
Anintvalue 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.
-
VIEW_RECOVERABLE_OBJECTS_AS_INT
public static final int VIEW_RECOVERABLE_OBJECTS_AS_INT
Anintvalue associated with the VIEW_RECOVERABLE_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
-
VIEW_RECOVERABLE_OBJECTS
public static final AccessRight VIEW_RECOVERABLE_OBJECTS
Specifies that the user or group is granted or denied permission to retrieve or query all recoverable objects in the object store. Because recoverable objects are logically deleted, most users' access should be limited to theCmRecoveryItemobjects that represent recoverable objects. Most users should be denied direct access to recoverable objects.
-
WRITE_ANY_OWNER_AS_INT
public static final int WRITE_ANY_OWNER_AS_INT
Anintvalue 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 grantedWRITE_ANY_OWNERpermission on anObjectStoreobject, then that user or group is also automatically granted theWRITE_OWNERpermission on all objects contained in that object store.
-
USE_MARKING_AS_INT
public static final int USE_MARKING_AS_INT
Anintvalue 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 theAccessRight.USE_MARKINGaccess right, then the constraint mask is applied to the effective access mask that was computed by the authorization service.
-
READ_AS_INT
public static final int READ_AS_INT
Anintvalue 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.
-
WRITE_ACL_AS_INT
public static final int WRITE_ACL_AS_INT
Anintvalue 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, itsPermissionListcollection).
-
MODIFY_RETENTION_AS_INT
public static final int MODIFY_RETENTION_AS_INT
Anintvalue associated with the MODIFY_RETENTION 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_RETENTION
public static final AccessRight MODIFY_RETENTION
This constant is not supported.
-
CREATE_CHILD_AS_INT
public static final int CREATE_CHILD_AS_INT
Anintvalue 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.
-
MODIFY_OBJECTS_AS_INT
public static final int MODIFY_OBJECTS_AS_INT
Anintvalue 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.
-
ADD_MARKING_AS_INT
public static final int ADD_MARKING_AS_INT
Anintvalue 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 aMarkingobject to an object.
-
VIEW_CONTENT_AS_INT
public static final int VIEW_CONTENT_AS_INT
Anintvalue 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.
-
-
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 aStringrepresentation of this enumeration instance.- Overrides:
toStringin classjava.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()
-
-