com.filenet.rm.bds

Interface PermissionValue


  1. public interface PermissionValue
This interface represents an individual CE security permission.

Field Summary

Modifier and Type Field and Description
  1. static
  2. int
GRANTEE_TYPE_GROUP
Value of 2001; specifies that the grantee is a group.
  1. static
  2. int
GRANTEE_TYPE_USER
Value of 2000; specifies that the grantee is a user.
  1. static
  2. int
INHERITABLE_DEPTH_NO_INHERITANCE
Value of 0; specifies that this permission cannot be inherited.
  1. static
  2. int
INHERITABLE_DEPTH_ONE_LEVEL
Value of 1; specifies that this permission can be inherited by immediate security children but no further.
  1. static
  2. int
INHERITABLE_DEPTH_UNLIMITED
Value of -1; specifies that this permission can be inherited by security children to any depth.
  1. static
  2. int
LEVEL_ADD_TO_FOLDER
An alias for LEVEL_LINK_FOLDER.
  1. static
  2. int
LEVEL_FULL_CONTROL
Specifies full access rights to an object for base level permissions and Web Content Management (WCM) extended permissions (deploy and archive).
  1. static
  2. int
LEVEL_FULL_CONTROL_ANNOTATION
Specifies full access rights to functions that can be performed on an Annotation object.
  1. static
  2. int
LEVEL_FULL_CONTROL_CLASSDEF
Specifies full access rights to functions that can be performed on a ClassDefinition object.
  1. static
  2. int
LEVEL_FULL_CONTROL_CUSTOM
Specifies full access rights to functions that can be performed on a CustomObject object.
  1. static
  2. int
LEVEL_FULL_CONTROL_DEFAULT
Specifies a combination of access rights to an object that grant or deny a user or group the permission to make most types of changes to a Content Engine object.
  1. static
  2. int
LEVEL_FULL_CONTROL_DOCUMENT
Specifies full access rights to functions that can be performed on a Document object.
  1. static
  2. int
LEVEL_FULL_CONTROL_FOLDER
Specifies full access rights to functions that can be performed on a Folder object.
  1. static
  2. int
LEVEL_FULL_CONTROL_FOLDER_INHERITABLE
Same as LEVEL_FULL_CONTROL_FOLDER, but with the addition of rights that are used only by those containees of the folder that inherit security from that folder.
  1. static
  2. int
LEVEL_FULL_CONTROL_MARKING
Specifies full access rights to an object for performing marking operations on an object.
  1. static
  2. int
LEVEL_LINK_CLASSDEF
Specifies that the user or group is granted or denied permission to link to and view a ClassDefinition object's properties and security.
  1. static
  2. int
LEVEL_LINK_CUSTOM
Specifies that the user or group is granted or denied permission to link to and view a CustomObject object's properties and security.
  1. static
  2. int
LEVEL_LINK_FOLDER
Specifies that the user or group is granted or denied permission to link to and unlink from a Folder object.
  1. static
  2. int
LEVEL_MAJOR_VERSION_DOCUMENT
Specifies that the user or group is granted or denied permission to create a new major version of a Document object's content.
  1. static
  2. int
LEVEL_MINOR_VERSION_DOCUMENT
Specifies that the user or group is granted or denied permission to create a new minor version of a Document object's content.
  1. static
  2. int
LEVEL_MODIFY_CONTENT_DOCUMENT
An alias for LEVEL_MAJOR_VERSION_DOCUMENT.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_ANNOTATION
An alias for LEVEL_WRITE_ANNOTATION.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_CLASSDEF
An alias for LEVEL_WRITE_CLASSDEF.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_CUSTOM
An alias for LEVEL_WRITE_CUSTOM.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_DEFAULT
An alias for LEVEL_WRITE_DEFAULT.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_DOCUMENT
An alias for LEVEL_WRITE_DOCUMENT.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_FOLDER
An alias for LEVEL_WRITE_FOLDER.
  1. static
  2. int
LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE
Same as LEVEL_WRITE_FOLDER, but with the addition of rights that are used only by containees of the folder that inherit security from that folder.
  1. static
  2. int
LEVEL_PUBLISH
Specifies that the user or group is granted or denied permission to publish the object; view its properties, security, and content; and link to the object.
  1. static
  2. int
LEVEL_PUBLISH_DOCUMENT
An alias for LEVEL_PUBLISH.
  1. static
  2. int
LEVEL_READ
Specifies that the user or group is granted or denied permission to view an object's properties and security.
  1. static
  2. int
LEVEL_VIEW
Specifies that the user or group is granted or denied permission to view an object's properties, security, and content.
  1. static
  2. int
LEVEL_VIEW_CONTENT
An alias for LEVEL_VIEW.
  1. static
  2. int
LEVEL_VIEW_PROPERTIES
An alias for LEVEL_READ.
  1. static
  2. int
LEVEL_WRITE_ANNOTATION
Specifies that the user or group is granted or denied permission to view an Annotation object's content; modify its properties; and create a new instance of an object.
  1. static
  2. int
LEVEL_WRITE_CLASSDEF
Specifies that the user or group is granted or denied permission to create an instance of the object; modify the object's properties; link to the object; and create an instance of the object.
  1. static
  2. int
LEVEL_WRITE_CUSTOM
Specifies that the user or group is granted or denied permission to link to a CustomObject object; view and modify its properties; and create a new instance of the object.
  1. static
  2. int
LEVEL_WRITE_DEFAULT
Specifies that the user or group is granted or denied permission to modify the object's properties and create a new instance of the object.
  1. static
  2. int
LEVEL_WRITE_DOCUMENT
Specifies that the user or group is granted or denied permission to link to a Document object; create a new instance of the object; change the object's lifecycle state; view its content; and modify its properties.
  1. static
  2. int
LEVEL_WRITE_FOLDER
Specifies that the user or group is granted or denied permission to create a subfolder under a Folder object.
  1. static
  2. int
PERMISSION_SOURCE_DEFAULT
Value of 1; specifies that the permission was acquired by default.
  1. static
  2. int
PERMISSION_SOURCE_DIRECT
Value of 0; specifies that the permission was directly added.
  1. static
  2. int
PERMISSION_SOURCE_PARENT
Value of 3; specifies that the permission was acquired from a security parent.
  1. static
  2. int
PERMISSION_SOURCE_TEMPLATE
Value of 2; specifies that the permission was acquired from a security template.
  1. static
  2. java.lang.String
PRINCIPAL_NAME_AUTHENTICATED_USERS
Value of "#AUTHENTICATED-USERS"; specifies that the security principal name is the built-in group called AUTHENTICATED-USERS.
  1. static
  2. java.lang.String
PRINCIPAL_NAME_CREATOR_OWNER
Value of "#CREATOR-OWNER"; specifies that the security principal name is the built-in group called CREATOR-OWNER.
  1. static
  2. java.lang.String[]
PRINCIPAL_NAME_SPECIAL
A String array that specifies the security principal name as the two built-in groups called CREATOR-OWNER and AUTHENTICATED-USERS.
  1. static
  2. int
RIGHT_ADD_MARKING
Value of 0x2000000; specifies that the user or group is granted or denied permission to assign a Marking object to an object.
  1. static
  2. int
RIGHT_ARCHIVE
Deprecated.
  1. static
  2. int
RIGHT_CHANGE_STATE
Value of 0x00000400; specifies that the user or group is granted or denied permission to change the lifecycle state of an object.
  1. static
  2. int
RIGHT_CREATE_CHILD
Value of 0x00000200; specifies that the user or group is granted or denied permission to create a child object.
  1. static
  2. int
RIGHT_CREATE_INSTANCE
Value of 0x00000100; specifies that the user or group is granted or denied permission to create a new instance of an object.
  1. static
  2. int
RIGHT_DELETE
Value of 0x00010000; specifies that the user or group is granted or denied permission to delete an object.
  1. static
  2. int
RIGHT_DEPLOY
Deprecated.
  1. static
  2. int
RIGHT_LINK
Value of 0x00000010; specifies that the user or group is granted or denied permission to link to an object.
  1. static
  2. int
RIGHT_MAJOR_VERSION
Value of 0x00000004; specifies that the user or group is granted or denied permission to create a document major version.
  1. static
  2. int
RIGHT_MINOR_VERSION
Value of 0x00000040; specifies that the user or group is granted or denied permission to create a new document minor version.
  1. static
  2. int
RIGHT_PUBLISH
Value of 0x00000800; specifies that the user or group is granted or denied permission to publish an object.
  1. static
  2. int
RIGHT_READ
Value of 0x00000001; specifies that the user or group is granted or denied permission to view the properties of an object.
  1. static
  2. int
RIGHT_READ_ACL
Value of 0x00020000; specifies that the user or group is granted or denied permission to view an object's security (that is, its Permissions collection).
  1. static
  2. int
RIGHT_REMOVE_MARKING
Value of 0x4000000; specifies that the user or group is granted or denied permission to remove a Marking object from an object.
  1. static
  2. int
RIGHT_UNLINK
Value of 0x00000020; specifies that the user or group is granted or denied permission to unlink from an object.
  1. static
  2. int
RIGHT_USE_MARKING
Value of 0x8000000; determines whether or not the constraint mask will be applied.
  1. static
  2. int
RIGHT_VIEW_CONTENT
Value of 0x00000080; specifies that the user or group is granted or denied permission to view the content of an object.
  1. static
  2. int
RIGHT_WRITE
Value of 0x00000002; specifies that the user or group is granted or denied permission to modify the properties of an object.
  1. static
  2. int
RIGHT_WRITE_ACL
Value of 0x00040000; specifies that the user or group is granted or denied permission to modify an object's security (that is, its Permissions collection).
  1. static
  2. int
RIGHT_WRITE_OWNER
Value of 0x00080000; specifies that the user or group is granted or denied permission to change an object's ownership.
  1. static
  2. int
TYPE_ALLOW
Value of 1; specifies that the user or group has permission for the given access to a specified object.
  1. static
  2. int
TYPE_DENY
Value of 2; specifies that the user or group does not have the given access to a specified object.

Method Summary

Modifier and Type Method and Description
  1. int
getAccessMask()
Returns an integer representing the type of permission assigned to a user or group.
  1. int
getAccessType()
Returns an integer that indicates whether a user or group is allowed or denied access.
  1. java.lang.String
getGranteeName()
Returns a String representing the name of the object being assigned permission.
  1. int
getGranteeType()
Returns the type of the permission grantee.
  1. int
getInheritableDepth()
Returns an integer that represents the maximum number of levels (depth) through which this permission can be inherited.
  1. int
getPermissionSource()
Returns the source of this permission.

Field Detail

GRANTEE_TYPE_USER

  1. static final int GRANTEE_TYPE_USER
Value of 2000; specifies that the grantee is a user.
See Also:

GRANTEE_TYPE_GROUP

  1. static final int GRANTEE_TYPE_GROUP
Value of 2001; specifies that the grantee is a group.
See Also:

TYPE_ALLOW

  1. static final int TYPE_ALLOW
Value of 1; specifies that the user or group has permission for the given access to a specified object.

Explicitly (directly) set permissions take precedence over inherited permissions. The order of precedence is: direct deny, direct allow, inherited deny, inherited allow.

See Also:

TYPE_DENY

  1. static final int TYPE_DENY
Value of 2; specifies that the user or group does not have the given access to a specified object. TYPE_DENY takes precedence over TYPE_ALLOW for a given user or group. For example, if RIGHT_WRITE permission to an object is denied for a group, any individual user in that group who has RIGHT_WRITE permission on the object will be denied RIGHT_WRITE access to it. The group's access type of TYPE_DENY takes precedence over an individual group member's access (TYPE_ALLOW) for the same permission on the same object.

Explicitly (directly) set permissions take precedence over inherited permissions. The order of precedence is: direct deny, direct allow, inherited deny, inherited allow.

See Also:

RIGHT_READ

  1. static final int RIGHT_READ
Value of 0x00000001; specifies that the user or group is granted or denied permission to view the properties of an object.
See Also:

RIGHT_WRITE

  1. static final int RIGHT_WRITE
Value of 0x00000002; specifies that the user or group is granted or denied permission to modify the properties of an object.
See Also:

RIGHT_MAJOR_VERSION

  1. static final int RIGHT_MAJOR_VERSION
Value of 0x00000004; specifies that the user or group is granted or denied permission to create a document major version.
See Also:

  1. static final int RIGHT_LINK
Value of 0x00000010; specifies that the user or group is granted or denied permission to link to an object.
See Also:

  1. static final int RIGHT_UNLINK
Value of 0x00000020; specifies that the user or group is granted or denied permission to unlink from an object.
See Also:

RIGHT_MINOR_VERSION

  1. static final int RIGHT_MINOR_VERSION
Value of 0x00000040; specifies that the user or group is granted or denied permission to create a new document minor version.
See Also:

RIGHT_VIEW_CONTENT

  1. static final int RIGHT_VIEW_CONTENT
Value of 0x00000080; specifies that the user or group is granted or denied permission to view the content of an object.
See Also:

RIGHT_CREATE_INSTANCE

  1. static final int RIGHT_CREATE_INSTANCE
Value of 0x00000100; specifies that the user or group is granted or denied permission to create a new instance of an object.
See Also:

RIGHT_CREATE_CHILD

  1. static final int RIGHT_CREATE_CHILD
Value of 0x00000200; specifies that the user or group is granted or denied permission to create a child object.
See Also:

RIGHT_CHANGE_STATE

  1. static final int RIGHT_CHANGE_STATE
Value of 0x00000400; specifies that the user or group is granted or denied permission to change the lifecycle state of an object.
See Also:

RIGHT_PUBLISH

  1. static final int RIGHT_PUBLISH
Value of 0x00000800; specifies that the user or group is granted or denied permission to publish an object.
See Also:

RIGHT_DEPLOY

  1. static final int RIGHT_DEPLOY
Deprecated.
See Also:

RIGHT_ARCHIVE

  1. static final int RIGHT_ARCHIVE
Deprecated.
See Also:

RIGHT_DELETE

  1. static final int RIGHT_DELETE
Value of 0x00010000; specifies that the user or group is granted or denied permission to delete an object.
See Also:

RIGHT_READ_ACL

  1. static final int RIGHT_READ_ACL
Value of 0x00020000; specifies that the user or group is granted or denied permission to view an object's security (that is, its Permissions collection).
See Also:

RIGHT_WRITE_ACL

  1. static final int RIGHT_WRITE_ACL
Value of 0x00040000; specifies that the user or group is granted or denied permission to modify an object's security (that is, its Permissions collection).
See Also:

RIGHT_WRITE_OWNER

  1. static final int RIGHT_WRITE_OWNER
Value of 0x00080000; specifies that the user or group is granted or denied permission to change an object's ownership.
See Also:

RIGHT_ADD_MARKING

  1. static final int RIGHT_ADD_MARKING
Value of 0x2000000; specifies that the user or group is granted or denied permission to assign a Marking object to an object.
See Also:

RIGHT_REMOVE_MARKING

  1. static final int RIGHT_REMOVE_MARKING
Value of 0x4000000; specifies that the user or group is granted or denied permission to remove a Marking object from an object.
See Also:

RIGHT_USE_MARKING

  1. static final int RIGHT_USE_MARKING
Value of 0x8000000; determines whether or not the constraint mask will be applied. If a user has been denied the RIGHT_USE_MARKING access right, then the constraint mask is applied to the Effective Access Mask that was computed by the authorization service.
See Also:

LEVEL_READ

  1. static final int LEVEL_READ
Specifies that the user or group is granted or denied permission to view an object's properties and security. Setting this access level is equivalent to setting the following combination of individual access rights:
RIGHT_READ | RIGHT_READ_ACL.
See Also:

LEVEL_VIEW_PROPERTIES

  1. static final int LEVEL_VIEW_PROPERTIES
An alias for LEVEL_READ.
See Also:

LEVEL_WRITE_DEFAULT

  1. static final int LEVEL_WRITE_DEFAULT
Specifies that the user or group is granted or denied permission to modify the object's properties and create a new instance of the object. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CREATE_INSTANCE | RIGHT_WRITE | LEVEL_READ.
See Also:

LEVEL_MODIFY_PROPERTIES_DEFAULT

  1. static final int LEVEL_MODIFY_PROPERTIES_DEFAULT
An alias for LEVEL_WRITE_DEFAULT.
See Also:

LEVEL_FULL_CONTROL_DEFAULT

  1. static final int LEVEL_FULL_CONTROL_DEFAULT
Specifies a combination of access rights to an object that grant or deny a user or group the permission to make most types of changes to a Content Engine object. See other "full control" levels applicable to specific object types.

In a WCM application, this level also grants or denies permission to deploy an object to a WCM-managed web site and to archive the object to a WCM database.

Assigning this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_ARCHIVE | RIGHT_DELETE | RIGHT_DEPLOY | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_WRITE_DEFAULT.

See Also:

LEVEL_VIEW

  1. static final int LEVEL_VIEW
Specifies that the user or group is granted or denied permission to view an object's properties, security, and content. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_VIEW_CONTENT | LEVEL_READ.
See Also:

LEVEL_VIEW_CONTENT

  1. static final int LEVEL_VIEW_CONTENT
An alias for LEVEL_VIEW.
See Also:

  1. static final int LEVEL_LINK_CLASSDEF
Specifies that the user or group is granted or denied permission to link to and view a ClassDefinition object's properties and security. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_LINK | LEVEL_READ.
See Also:

  1. static final int LEVEL_LINK_CUSTOM
Specifies that the user or group is granted or denied permission to link to and view a CustomObject object's properties and security. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_LINK | LEVEL_READ.
See Also:

  1. static final int LEVEL_LINK_FOLDER
Specifies that the user or group is granted or denied permission to link to and unlink from a Folder object. The user or group can also view the folder's properties and security. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_LINK | RIGHT_UNLINK | LEVEL_READ.
See Also:

LEVEL_ADD_TO_FOLDER

  1. static final int LEVEL_ADD_TO_FOLDER
An alias for LEVEL_LINK_FOLDER.
See Also:

LEVEL_PUBLISH

  1. static final int LEVEL_PUBLISH
Specifies that the user or group is granted or denied permission to publish the object; view its properties, security, and content; and link to the object. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_LINK | RIGHT_PUBLISH | LEVEL_VIEW.
See Also:

LEVEL_PUBLISH_DOCUMENT

  1. static final int LEVEL_PUBLISH_DOCUMENT
An alias for LEVEL_PUBLISH.
See Also:

LEVEL_WRITE_ANNOTATION

  1. static final int LEVEL_WRITE_ANNOTATION
Specifies that the user or group is granted or denied permission to view an Annotation object's content; modify its properties; and create a new instance of an object. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CREATE_INSTANCE | RIGHT_VIEW_CONTENT | RIGHT_WRITE | LEVEL_READ.
See Also:

LEVEL_MODIFY_PROPERTIES_ANNOTATION

  1. static final int LEVEL_MODIFY_PROPERTIES_ANNOTATION
An alias for LEVEL_WRITE_ANNOTATION.
See Also:

LEVEL_WRITE_CLASSDEF

  1. static final int LEVEL_WRITE_CLASSDEF
Specifies that the user or group is granted or denied permission to create an instance of the object; modify the object's properties; link to the object; and create an instance of the object. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CREATE_CHILD | RIGHT_CREATE_INSTANCE | RIGHT_LINK | RIGHT_WRITE | LEVEL_READ.
See Also:

LEVEL_MODIFY_PROPERTIES_CLASSDEF

  1. static final int LEVEL_MODIFY_PROPERTIES_CLASSDEF
An alias for LEVEL_WRITE_CLASSDEF.
See Also:

LEVEL_WRITE_CUSTOM

  1. static final int LEVEL_WRITE_CUSTOM
Specifies that the user or group is granted or denied permission to link to a CustomObject object; view and modify its properties; and create a new instance of the object. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CREATE_INSTANCE | RIGHT_LINK | RIGHT_WRITE | LEVEL_READ.
See Also:

LEVEL_MODIFY_PROPERTIES_CUSTOM

  1. static final int LEVEL_MODIFY_PROPERTIES_CUSTOM
An alias for LEVEL_WRITE_CUSTOM.
See Also:

LEVEL_WRITE_DOCUMENT

  1. static final int LEVEL_WRITE_DOCUMENT
Specifies that the user or group is granted or denied permission to link to a Document object; create a new instance of the object; change the object's lifecycle state; view its content; and modify its properties. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CHANGE_STATE | RIGHT_CREATE_INSTANCE | RIGHT_LINK | RIGHT_VIEW_CONTENT | RIGHT_WRITE | LEVEL_READ.
See Also:

LEVEL_MODIFY_PROPERTIES_DOCUMENT

  1. static final int LEVEL_MODIFY_PROPERTIES_DOCUMENT
An alias for LEVEL_WRITE_DOCUMENT.
See Also:

LEVEL_WRITE_FOLDER

  1. static final int LEVEL_WRITE_FOLDER
Specifies that the user or group is granted or denied permission to create a subfolder under a Folder object. The user or group can also link to and unlink from the subfolder and modify its properties. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CHANGE_STATE | RIGHT_CREATE_CHILD | RIGHT_CREATE_INSTANCE | RIGHT_LINK | RIGHT_UNLINK | RIGHT_MINOR_VERSION | RIGHT_MAJOR_VERSION | RIGHT_PUBLISH | RIGHT_VIEW_CONTENT | RIGHT_WRITE | LEVEL_READ.
See Also:

LEVEL_MODIFY_PROPERTIES_FOLDER

  1. static final int LEVEL_MODIFY_PROPERTIES_FOLDER
An alias for LEVEL_WRITE_FOLDER.
See Also:

LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE

  1. static final int LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE
Same as LEVEL_WRITE_FOLDER, but with the addition of rights that are used only by containees of the folder that inherit security from that folder. Those additional rights are:
RIGHT_CHANGE_STATE | RIGHT_MAJOR_VERSION | RIGHT_MINOR_VERSION | RIGHT_PUBLISH | RIGHT_VIEW_CONTENT.
See Also:

LEVEL_MAJOR_VERSION_DOCUMENT

  1. static final int LEVEL_MAJOR_VERSION_DOCUMENT
Specifies that the user or group is granted or denied permission to create a new major version of a Document object's content. The user or group can also link to a Document object; change its state; modify its properties; and view its content. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_MAJOR_VERSION | RIGHT_MINOR_VERSION | LEVEL_MODIFY_PROPERTIES_DOCUMENT.
See Also:

LEVEL_MINOR_VERSION_DOCUMENT

  1. static final int LEVEL_MINOR_VERSION_DOCUMENT
Specifies that the user or group is granted or denied permission to create a new minor version of a Document object's content. The user or group can also link to a Document object; change its state; modify its properties; and view its content. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_MINOR_VERSION | LEVEL_MODIFY_PROPERTIES_DOCUMENT.
See Also:

LEVEL_MODIFY_CONTENT_DOCUMENT

  1. static final int LEVEL_MODIFY_CONTENT_DOCUMENT
An alias for LEVEL_MAJOR_VERSION_DOCUMENT.
See Also:

LEVEL_FULL_CONTROL_ANNOTATION

  1. static final int LEVEL_FULL_CONTROL_ANNOTATION
Specifies full access rights to functions that can be performed on an Annotation object. A user or group assigned this level of access is granted or denied permission to create an instance of the object; modify the object's properties and security; change the object's ownership; and view the object's content. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_DELETE | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_MODIFY_PROPERTIES_ANNOTATION.
See Also:

LEVEL_FULL_CONTROL_CLASSDEF

  1. static final int LEVEL_FULL_CONTROL_CLASSDEF
Specifies full access rights to functions that can be performed on a ClassDefinition object. A user or group assigned this level of access is granted or denied permission to modify the object's properties and security; create an instance of the object; change the object's ownership; and delete the object. Assigning this access level is equivalent to setting the following combination of Level access rights:
RIGHT_DELETE | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_MODIFY_PROPERTIES_CLASSDEF.
See Also:

LEVEL_FULL_CONTROL_CUSTOM

  1. static final int LEVEL_FULL_CONTROL_CUSTOM
Specifies full access rights to functions that can be performed on a CustomObject object. A user or group assigned this level of access is granted or denied permission to link to the object; modify its properties and its security; change the object's ownership; and delete the object. In a Web Content Management application, this level also grants or denies permission to deploy the CustomObject object to a WCM-managed web site and archive it to WCM archive database. Assigning this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_ARCHIVE | RIGHT_DELETE | RIGHT_DEPLOY | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_MODIFY_PROPERTIES_CUSTOM | .
See Also:

LEVEL_FULL_CONTROL_DOCUMENT

  1. static final int LEVEL_FULL_CONTROL_DOCUMENT
Specifies full access rights to functions that can be performed on a Document object. A user or group assigned this level of access is granted or denied permission to link to the Document object; publish the document; modify its properties and its security; change its state; view its contents; create a new version of its content; and changes its ownership. In a Web Content Management application, this level also grants or denies permission to deploy the Document object to a WCM-managed web site and archive it to a WCM archive database. Assigning this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_ARCHIVE | RIGHT_DELETE | RIGHT_DEPLOY | RIGHT_MAJOR_VERSION | RIGHT_PUBLISH | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_MODIFY_CONTENT_DOCUMENT.
See Also:

LEVEL_FULL_CONTROL_FOLDER

  1. static final int LEVEL_FULL_CONTROL_FOLDER
Specifies full access rights to functions that can be performed on a Folder object. A user or group assigned this level of access is granted or denied permission to link to and unlink from the Folder object; create a subfolder; modify the object's properties and its security; change the object's ownership; and delete the object. In a Web Content Management (WCM) application, this level also grants or denies permission to deploy the folder to a WCM-managed web site and archive the folder to a WCM database. Assigning this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_ARCHIVE | RIGHT_DELETE | RIGHT_DEPLOY | RIGHT_MAJOR_VERSION | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_MODIFY_PROPERTIES_FOLDER.
See Also:

LEVEL_FULL_CONTROL_FOLDER_INHERITABLE

  1. static final int LEVEL_FULL_CONTROL_FOLDER_INHERITABLE
Same as LEVEL_FULL_CONTROL_FOLDER, but with the addition of rights that are used only by those containees of the folder that inherit security from that folder. Those additional rights are:
RIGHT_CHANGE_STATE | RIGHT_MINOR_VERSION | RIGHT_PUBLISH | RIGHT_VIEW_CONTENT.
See Also:

LEVEL_FULL_CONTROL

  1. static final int LEVEL_FULL_CONTROL
Specifies full access rights to an object for base level permissions and Web Content Management (WCM) extended permissions (deploy and archive). A user or group assigned this level is granted or denied permission to perform all available Content Engine and Web Content Management (WCM) functions on the object. In a WCM application, this includes deploying the object to a WCM-managed web site and archiving it to a WCM archive database. Setting this access level is equivalent to specifying all of the available LEVEL_FULL_CONTROL_XXX constants.

See Also:

LEVEL_FULL_CONTROL_MARKING

  1. static final int LEVEL_FULL_CONTROL_MARKING
Specifies full access rights to an object for performing marking operations on an object. A user or group assigned this level is granted or denied permission to perform all available marking functions on the object. Setting this access level is equivalent to specifying the following combination of individual access rights:
RIGHT_ADD_MARKING | RIGHT_REMOVE_MARKING | RIGHT_USE_MARKING.
See Also:

PERMISSION_SOURCE_DIRECT

  1. static final int PERMISSION_SOURCE_DIRECT
Value of 0; specifies that the permission was directly added. For example, making an explicit call to setPermissions directly assigns permissions to an object and sets its PermissionSource property to a value of 0.
See Also:

PERMISSION_SOURCE_DEFAULT

  1. static final int PERMISSION_SOURCE_DEFAULT
Value of 1; specifies that the permission was acquired by default. For example, if no permissions are specified when an object is created, the permissions on the class are assigned to the object.
See Also:

PERMISSION_SOURCE_TEMPLATE

  1. static final int PERMISSION_SOURCE_TEMPLATE
Value of 2; specifies that the permission was acquired from a security template. Permissions acquired from a template are considered to be directly set and take precedence over inherited permissions.
See Also:

PERMISSION_SOURCE_PARENT

  1. static final int PERMISSION_SOURCE_PARENT
Value of 3; specifies that the permission was acquired from a security parent. For example, a document can inherit its permissions from the folder in which it is contained, that is, its security parent.
See Also:

INHERITABLE_DEPTH_NO_INHERITANCE

  1. static final int INHERITABLE_DEPTH_NO_INHERITANCE
Value of 0; specifies that this permission cannot be inherited.
See Also:

INHERITABLE_DEPTH_ONE_LEVEL

  1. static final int INHERITABLE_DEPTH_ONE_LEVEL
Value of 1; specifies that this permission can be inherited by immediate security children but no further.
See Also:

INHERITABLE_DEPTH_UNLIMITED

  1. static final int INHERITABLE_DEPTH_UNLIMITED
Value of -1; specifies that this permission can be inherited by security children to any depth.
See Also:

PRINCIPAL_NAME_CREATOR_OWNER

  1. static final java.lang.String PRINCIPAL_NAME_CREATOR_OWNER
Value of "#CREATOR-OWNER"; specifies that the security principal name is the built-in group called CREATOR-OWNER.
See Also:

PRINCIPAL_NAME_AUTHENTICATED_USERS

  1. static final java.lang.String PRINCIPAL_NAME_AUTHENTICATED_USERS
Value of "#AUTHENTICATED-USERS"; specifies that the security principal name is the built-in group called AUTHENTICATED-USERS.
See Also:

PRINCIPAL_NAME_SPECIAL

  1. static final java.lang.String[] PRINCIPAL_NAME_SPECIAL
A String array that specifies the security principal name as the two built-in groups called CREATOR-OWNER and AUTHENTICATED-USERS.

Method Detail

getAccessMask

  1. int getAccessMask()
Returns an integer representing the type of permission assigned to a user or group.

To determine whether the permission returned by a call to getAccessMask() is allowed or denied, call getAccessType().

Returns:
An integer representing the assigned access rights.

getAccessType

  1. int getAccessType()
Returns an integer that indicates whether a user or group is allowed or denied access.

To determine the permissions that a call to getAccessType reports as allowed or denied, call getAccessMask().

Returns:
An integer that represents the access type granted. A value of 1 indicates that access is allowed; 2 indicates access is denied.

getGranteeName

  1. java.lang.String getGranteeName( )
Returns a String representing the name of the object being assigned permission. (To determine if the grantee is a user or group, call getGranteeType()).
Returns:
A String representing the grantee name.

getGranteeType

  1. int getGranteeType()
Returns the type of the permission grantee. The type is returned as an integer, which maps to one of two types as defined by GRANTEE_TYPE_USER (2000) or GRANTEE_TYPE_GROUP (2001).
Returns:
An integer representing the type of the grantee.

getPermissionSource

  1. int getPermissionSource()
Returns the source of this permission.
Returns:
An integer representing the source of this permission.

getInheritableDepth

  1. int getInheritableDepth()
Returns an integer that represents the maximum number of levels (depth) through which this permission can be inherited.

A value of ... indicates that the permission ...
0 (INHERITABLE_DEPTH_NO_INHERITANCE) cannot be inherited.
1 (INHERITABLE_DEPTH_ONE_LEVEL) is restricted to inheritance by the immediate security child only.
-1 (INHERITABLE_DEPTH_UNLIMITED) can be inherited by an infinite level of security children.

You must have RIGHT_READ_ACL permissions to be able to retrieve this value.

Returns:
An integer that specifies to what level this permission can be inherited.