FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface Permission

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
Permission

public interface Permission
extends java.io.Serializable

A Permission object represents an access control (or rule) associated with with a Folder or Document object. The set of access controls comprise an Access Control List (ACL), which is represented by a CS Java Connector Permissions collection object. An individual Permission object corresponds to an Access Control Entry (ACE).

You can create a Permission object in the following ways:

See Also:
CS Java Toolkit Developer's Guide

Field Summary
static int INHERITABLE_DEPTH_NO_INHERITANCE
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 0; specifies that this permission cannot be inherited.
static int INHERITABLE_DEPTH_ONE_LEVEL
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 1; specifies that this permission can be inherited by immediate security children but no further.
static int INHERITABLE_DEPTH_UNLIMITED
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of -1; specifies that this permission can be inherited by security children to any depth.
static int INHERITANCE_TYPE_ALL_CONTAINED_OBJECTS
          

Not Implemented in CS Java Connector v3.0.

static int INHERITANCE_TYPE_CONTAINED_CUSTOM_OBJECTS
          

Not Implemented in CS Java Connector v3.0.

static int INHERITANCE_TYPE_CONTAINED_DOCUMENT_OBJECTS
          

Not Implemented in CS Java Connector v3.0.

static int INHERITANCE_TYPE_CONTAINED_FOLDER_OBJECTS
          

Not Implemented in CS Java Connector v3.0.

static int INHERITANCE_TYPE_FROM_SECURITY_POLICY
          

Not Implemented in CS Java Connector v3.0.

static int INHERITANCE_TYPE_NO_INHERITANCE
          

Not Implemented in CS Java Connector v3.0.

static int INHERITANCE_TYPE_OBJECT_INSTANCE
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7;
static int INHERITANCE_TYPE_THIS_OBJECT_AND_ALL_CONTAINED_OBJECTS
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_ADD_TO_FOLDER
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_ANNOTATION
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_CLASSDEF
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_CUSTOM
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_DEFAULT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_FOLDER
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_FOLDER_INHERITABLE
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_FULL_CONTROL_MARKING
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_LINK_CLASSDEF
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_LINK_CUSTOM
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_LINK_FOLDER
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MAJOR_VERSION_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MINOR_VERSION_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_CONTENT_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_ANNOTATION
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_CLASSDEF
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_CUSTOM
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_DEFAULT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_FOLDER
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_PUBLISH
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_PUBLISH_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_READ
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_VIEW
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_VIEW_CONTENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_VIEW_PROPERTIES
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_WRITE_ANNOTATION
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_WRITE_CLASSDEF
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_WRITE_CUSTOM
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_WRITE_DEFAULT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_WRITE_DOCUMENT
          

Not Implemented in CS Java Connector v3.0.

static int LEVEL_WRITE_FOLDER
          

Not Implemented in CS Java Connector v3.0.

static int PERMISSION_SOURCE_DEFAULT
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 1; specifies that the permission was acquired by default.
static int PERMISSION_SOURCE_DIRECT
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 0; specifies that the permission was directly added.
static int PERMISSION_SOURCE_PARENT
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 3; specifies that the permission was acquired from a security parent.
static int PERMISSION_SOURCE_TEMPLATE
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 2; specifies that the permission was acquired from a security template.
static int PERMISSION_TYPE_LEVEL
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 0; specifies a permission type for the described permission as an access level (that is, a bit mask of access rights).
static int PERMISSION_TYPE_LEVEL_DEFAULT
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 1; specifies a permission type for the described permission as an access level default (LEVEL_FULL_CONTROL_DEFAULT, for example).
static int PERMISSION_TYPE_RIGHT
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 2; specifies a permission type for the described permission as a single access right (RIGHT_WRITE, for example).
static int PERMISSION_TYPE_RIGHT_INHERIT_ONLY
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 3; specifies a permission type for the described permission as applicable only to inheritable permissions.
static java.lang.String PRINCIPAL_ID_AUTHENTICATED_USERS
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "S-1-5-11"; specifies the security ID (SID) for the AUTHENTICATED-USERS account.
static java.lang.String PRINCIPAL_ID_CREATOR_OWNER
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "S-1-3-0"; specifies the security ID (SID) for the CREATOR-OWNER account.
static java.lang.String[] PRINCIPAL_ID_SPECIAL
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7;
static java.lang.String PRINCIPAL_NAME_AUTHENTICATED_USERS
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "#AUTHENTICATED-USERS"; specifies that the security principal name is the built-in group called AUTHENTICATED-USERS.
static java.lang.String PRINCIPAL_NAME_CREATOR_OWNER
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "#CREATOR-OWNER"; specifies that the security principal name is the built-in group called CREATOR-OWNER.
static java.lang.String[] PRINCIPAL_NAME_SPECIAL
          public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; A String array that specifies the security principal name as the two built-in groups called CREATOR-OWNER and AUTHENTICATED-USERS.
static int RIGHT_ADD_MARKING
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_ARCHIVE
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_CHANGE_STATE
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_CREATE_CHILD
          *

Not Implemented in CS Java Connector v3.0.

static int RIGHT_CREATE_INSTANCE
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_DELETE
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_DEPLOY
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_LINK
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_MAJOR_VERSION
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_MINOR_VERSION
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_PUBLISH
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_READ
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_READ_ACL
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_REMOVE_MARKING
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_UNLINK
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_USE_MARKING
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_VIEW_CONTENT
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_WRITE
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_WRITE_ACL
          

Not Implemented in CS Java Connector v3.0.

static int RIGHT_WRITE_OWNER
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_ALLOW
          

Not Implemented in CS Java Connector v3.0.

static int TYPE_DENY
          

Not Implemented in CS Java Connector v3.0.

 
Method Summary
 int getAccess()
          Returns an integer indicating the access level assigned to a user or group.
 int getAccessType()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getGranteeName()
          Returns a String representing the name of the object being assigned permission.
 int getGranteeType()
          Returns the object type of the permission grantee.
 int getInheritableDepth()
          

Not Implemented in CS Java Connector v3.0.

 int getInheritanceType()
          Deprecated. Use getInheritableDepth
 int getPermissionSource()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String[] getSpecialPrincipalIds()
          

Not Implemented in CS Java Connector v3.0.

 boolean isInherited()
          

Not Implemented in CS Java Connector v3.0.

 void setAccess(int access)
          Sets the access level (permissions) being granted or denied to a user or group.
 void setAccessType(int accessType)
          

Not Implemented in CS Java Connector v3.0.

 void setGrantee(SecurityGrantee grantee)
          Sets the object type of the grantee.
 void setGranteeName(java.lang.String granteeName)
          Sets the name of the object being granted permission.
 void setGranteeType(int granteeType)
          Sets the object type of the permission grantee.
 void setInheritableDepth(int inheritableDepth)
          

Not Implemented in CS Java Connector v3.0.

 void setInheritanceType(int inheritanceType)
          Deprecated. Use setInheritableDepth
 

Field Detail

TYPE_ALLOW

public static final int TYPE_ALLOW

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

TYPE_DENY

public static final int TYPE_DENY

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

RIGHT_READ

public static final int RIGHT_READ

Not Implemented in CS Java Connector v3.0.

Value of 0x00000001; specifies that the user or group is granted or denied permission to view the properties of an object.

See Also:
Constant Field Values

RIGHT_DEPLOY

public static final int RIGHT_DEPLOY

Not Implemented in CS Java Connector v3.0.

Value of 0x00001000; specifies that the user or group is granted or denied permission to deploy an object to a Web Content Management (WCM) web site.

See Also:
Constant Field Values

RIGHT_ARCHIVE

public static final int RIGHT_ARCHIVE

Not Implemented in CS Java Connector v3.0.

Value of 0x00002000; specifies that the user or group is granted or denied permission to archive an object to a Web Content Management (WCM) archive database.

See Also:
Constant Field Values

RIGHT_MAJOR_VERSION

public static final int RIGHT_MAJOR_VERSION

Not Implemented in CS Java Connector v3.0.

Value of 0x00000004; specifies that the user or group is granted or denied permission to create a document major version.

See Also:
Constant Field Values

RIGHT_WRITE

public static final int RIGHT_WRITE

Not Implemented in CS Java Connector v3.0.

Value of 0x00000002; specifies that the user or group is granted or denied permission to modify the properties of an object.

See Also:
Constant Field Values

RIGHT_LINK

public static final int RIGHT_LINK

Not Implemented in CS Java Connector v3.0.

Value of 0x00000010; specifies that the user or group is granted or denied permission to link to an object.

See Also:
Constant Field Values

RIGHT_UNLINK

public static final int RIGHT_UNLINK

Not Implemented in CS Java Connector v3.0.

Value of 0x00000020; specifies that the user or group is granted or denied permission to unlink from an object.

See Also:
Constant Field Values

RIGHT_MINOR_VERSION

public static final int RIGHT_MINOR_VERSION

Not Implemented in CS Java Connector v3.0.

Value of 0x00000040; specifies that the user or group is granted or denied permission to create a new document minor version.

See Also:
Constant Field Values

RIGHT_VIEW_CONTENT

public static final int RIGHT_VIEW_CONTENT

Not Implemented in CS Java Connector v3.0.

Value of 0x00000080; specifies that the user or group is granted or denied permission to view the content of an object.

See Also:
Constant Field Values

RIGHT_CREATE_INSTANCE

public static final int RIGHT_CREATE_INSTANCE

Not Implemented in CS Java Connector v3.0.

Value of 0x00000100; specifies that the user or group is granted or denied permission to create a new instance of an object.

See Also:
Constant Field Values

RIGHT_CREATE_CHILD

public static final int RIGHT_CREATE_CHILD
*

Not Implemented in CS Java Connector v3.0.

Value of 0x00000200; specifies that the user or group is granted or denied permission to create a child object.

See Also:
Constant Field Values

RIGHT_CHANGE_STATE

public static final int RIGHT_CHANGE_STATE

Not Implemented in CS Java Connector v3.0.

Value of 0x00000400; specifies that the user or group is granted or denied permission to change the lifecycle state of an object.

See Also:
Constant Field Values

RIGHT_PUBLISH

public static final int RIGHT_PUBLISH

Not Implemented in CS Java Connector v3.0.

Value of 0x00000800; specifies that the user or group is granted or denied permission to publish an object.

See Also:
Constant Field Values

RIGHT_DELETE

public static final int RIGHT_DELETE

Not Implemented in CS Java Connector v3.0.

Value of 0x00010000; specifies that the user or group is granted or denied permission to delete an object.

See Also:
Constant Field Values

RIGHT_READ_ACL

public static final int RIGHT_READ_ACL

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

RIGHT_WRITE_ACL

public static final int RIGHT_WRITE_ACL

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

RIGHT_WRITE_OWNER

public static final int RIGHT_WRITE_OWNER

Not Implemented in CS Java Connector v3.0.

Value of 0x00080000; specifies that the user or group is granted or denied permission to change an object's ownership.

See Also:
Constant Field Values

RIGHT_ADD_MARKING

public static final int RIGHT_ADD_MARKING

Not Implemented in CS Java Connector v3.0.

Value of 0x2000000; specifies that the user or group is granted or denied permission to assign a Marking object to an object.

See Also:
Constant Field Values

RIGHT_REMOVE_MARKING

public static final int RIGHT_REMOVE_MARKING

Not Implemented in CS Java Connector v3.0.

Value of 0x4000000; specifies that the user or group is granted or denied permission to remove a Marking object from an object.

See Also:
Constant Field Values

RIGHT_USE_MARKING

public static final int RIGHT_USE_MARKING

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_READ

public static final int LEVEL_READ

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_VIEW_PROPERTIES

public static final int LEVEL_VIEW_PROPERTIES

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_READ.

See Also:
Constant Field Values

LEVEL_WRITE_DEFAULT

public static final int LEVEL_WRITE_DEFAULT

Not Implemented in CS Java Connector v3.0.

Specifies that the user or group is granted or denied permission to modify an object's properties. 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:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_DEFAULT

public static final int LEVEL_MODIFY_PROPERTIES_DEFAULT

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_WRITE_DEFAULT.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_DEFAULT

public static final int LEVEL_FULL_CONTROL_DEFAULT

Not Implemented in CS Java Connector v3.0.

Specifies a combination of access rights to an object which grants or denies a user or group the permission to make most types of changes to a Content Services 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_DELETE | RIGHT_DEPLOY | RIGHT_ARCHIVE | RIGHT_WRITE_ACL | RIGHT_WRITE_OWNER | LEVEL_WRITE_DEFAULT.

See Also:
Constant Field Values

LEVEL_VIEW

public static final int LEVEL_VIEW

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_VIEW_CONTENT

public static final int LEVEL_VIEW_CONTENT

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_VIEW.

See Also:
Constant Field Values

LEVEL_LINK_CLASSDEF

public static final int LEVEL_LINK_CLASSDEF

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_LINK_CUSTOM

public static final int LEVEL_LINK_CUSTOM

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_LINK_FOLDER

public static final int LEVEL_LINK_FOLDER

Not Implemented in CS Java Connector v3.0.

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 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:
Constant Field Values

LEVEL_ADD_TO_FOLDER

public static final int LEVEL_ADD_TO_FOLDER

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_LINK_FOLDER.

See Also:
Constant Field Values

LEVEL_PUBLISH

public static final int LEVEL_PUBLISH

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_PUBLISH_DOCUMENT

public static final int LEVEL_PUBLISH_DOCUMENT

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_PUBLISH.

See Also:
Constant Field Values

LEVEL_WRITE_ANNOTATION

public static final int LEVEL_WRITE_ANNOTATION

Not Implemented in CS Java Connector v3.0.

Specifies that the user or group is granted or denied permission to view an Annotation object's content and modify its properties. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_VIEW_CONTENT | LEVEL_WRITE_DEFAULT.

See Also:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_ANNOTATION

public static final int LEVEL_MODIFY_PROPERTIES_ANNOTATION

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_WRITE_ANNOTATION.

See Also:
Constant Field Values

LEVEL_WRITE_CLASSDEF

public static final int LEVEL_WRITE_CLASSDEF

Not Implemented in CS Java Connector v3.0.

Specifies that the user or group is granted or denied permission to modify an object's properties and create a child object. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_CREATE_CHILD | RIGHT_LINK | LEVEL_WRITE_DEFAULT.

See Also:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_CLASSDEF

public static final int LEVEL_MODIFY_PROPERTIES_CLASSDEF

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_WRITE_CLASSDEF.

See Also:
Constant Field Values

LEVEL_WRITE_CUSTOM

public static final int LEVEL_WRITE_CUSTOM

Not Implemented in CS Java Connector v3.0.

Specifies that the user or group is granted or denied permission to link to a CustomObject object and modify its properties. Setting this access level is equivalent to setting the following combination of individual and Level access rights:
RIGHT_LINK | LEVEL_WRITE_DEFAULT.

See Also:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_CUSTOM

public static final int LEVEL_MODIFY_PROPERTIES_CUSTOM

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_WRITE_CUSTOM.

See Also:
Constant Field Values

LEVEL_WRITE_DOCUMENT

public static final int LEVEL_WRITE_DOCUMENT

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_DOCUMENT

public static final int LEVEL_MODIFY_PROPERTIES_DOCUMENT

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_WRITE_DOCUMENT.

See Also:
Constant Field Values

LEVEL_WRITE_FOLDER

public static final int LEVEL_WRITE_FOLDER

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_FOLDER

public static final int LEVEL_MODIFY_PROPERTIES_FOLDER

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_WRITE_FOLDER.

See Also:
Constant Field Values

LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE

public static final int LEVEL_MODIFY_PROPERTIES_FOLDER_INHERITABLE

Not Implemented in CS Java Connector v3.0.

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_MAJOR_VERSION | RIGHT_MINOR_VERSION | RIGHT_VIEW_CONTENT | RIGHT_CHANGE_STATE | RIGHT_PUBLISH.

See Also:
Constant Field Values

LEVEL_MAJOR_VERSION_DOCUMENT

public static final int LEVEL_MAJOR_VERSION_DOCUMENT

Not Implemented in CS Java Connector v3.0.

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 and unlink from 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:
Constant Field Values

LEVEL_MINOR_VERSION_DOCUMENT

public static final int LEVEL_MINOR_VERSION_DOCUMENT

Not Implemented in CS Java Connector v3.0.

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 and unlink from 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:
Constant Field Values

LEVEL_MODIFY_CONTENT_DOCUMENT

public static final int LEVEL_MODIFY_CONTENT_DOCUMENT

Not Implemented in CS Java Connector v3.0.

An alias for LEVEL_MAJOR_VERSION_DOCUMENT.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_ANNOTATION

public static final int LEVEL_FULL_CONTROL_ANNOTATION

Not Implemented in CS Java Connector v3.0.

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 link to the object; modify its properties and security; and view the object's content. Setting this access level is equivalent to setting the following combination of Level access rights:
LEVEL_FULL_CONTROL_DEFAULT | LEVEL_MODIFY_PROPERTIES_ANNOTATION.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_CLASSDEF

public static final int LEVEL_FULL_CONTROL_CLASSDEF

Not Implemented in CS Java Connector v3.0.

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 and create a child object. Assigning this access level is equivalent to setting the following combination of Level access rights:
LEVEL_FULL_CONTROL_DEFAULT | LEVEL_MODIFY_PROPERTIES_CLASSDEF.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_CUSTOM

public static final int LEVEL_FULL_CONTROL_CUSTOM

Not Implemented in CS Java Connector v3.0.

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 and to modify its properties and its security. 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:
LEVEL_FULL_CONTROL_DEFAULT | LEVEL_MODIFY_PROPERTIES_CUSTOM | RIGHT_DEPLOY | RIGHT_ARCHIVE.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_DOCUMENT

public static final int LEVEL_FULL_CONTROL_DOCUMENT

Not Implemented in CS Java Connector v3.0.

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 and unlink from the Document object; publish the document; modify its properties and its security; change its state; view its contents; and create a new version of its content. 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:
LEVEL_FULL_CONTROL_DEFAULT | LEVEL_MODIFY_CONTENT_DOCUMENT | RIGHT_PUBLISH | RIGHT_MAJOR_VERSION | RIGHT_DEPLOY | RIGHT_ARCHIVE.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_FOLDER

public static final int LEVEL_FULL_CONTROL_FOLDER

Not Implemented in CS Java Connector v3.0.

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; and modify the object's properties and its security. 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:
LEVEL_FULL_CONTROL_DEFAULT | LEVEL_MODIFY_PROPERTIES_FOLDER | RIGHT_DEPLOY | RIGHT_ARCHIVE | RIGHT_MAJOR_VERSION.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL_FOLDER_INHERITABLE

public static final int LEVEL_FULL_CONTROL_FOLDER_INHERITABLE

Not Implemented in CS Java Connector v3.0.

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_MINOR_VERSION | RIGHT_VIEW_CONTENT | RIGHT_CHANGE_STATE | RIGHT_PUBLISH.

See Also:
Constant Field Values

LEVEL_FULL_CONTROL

public static final int LEVEL_FULL_CONTROL

Not Implemented in CS Java Connector v3.0.

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 all available Content Services 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:
Constant Field Values

LEVEL_FULL_CONTROL_MARKING

public static final int LEVEL_FULL_CONTROL_MARKING

Not Implemented in CS Java Connector v3.0.

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:
Constant Field Values

INHERITANCE_TYPE_ALL_CONTAINED_OBJECTS

public static final int INHERITANCE_TYPE_ALL_CONTAINED_OBJECTS

Not Implemented in CS Java Connector v3.0.

See Also:
Constant Field Values

INHERITANCE_TYPE_CONTAINED_CUSTOM_OBJECTS

public static final int INHERITANCE_TYPE_CONTAINED_CUSTOM_OBJECTS

Not Implemented in CS Java Connector v3.0.

Value of 6; specifies that security is to be inherited by contained objects whose class is CustomObject or a subclass of CustomObject.

See Also:
Constant Field Values

INHERITANCE_TYPE_CONTAINED_DOCUMENT_OBJECTS

public static final int INHERITANCE_TYPE_CONTAINED_DOCUMENT_OBJECTS

Not Implemented in CS Java Connector v3.0.

Value of 5; specifies that security is to be inherited by contained objects whose class is Document or a subclass of Document.

See Also:
Constant Field Values

INHERITANCE_TYPE_CONTAINED_FOLDER_OBJECTS

public static final int INHERITANCE_TYPE_CONTAINED_FOLDER_OBJECTS

Not Implemented in CS Java Connector v3.0.

Value of 4; specifies that security is to be inherited by contained objects whose class is Folder or a subclass of Folder.

See Also:
Constant Field Values

INHERITANCE_TYPE_OBJECT_INSTANCE

public static final int INHERITANCE_TYPE_OBJECT_INSTANCE
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7;

See Also:
Constant Field Values

INHERITANCE_TYPE_NO_INHERITANCE

public static final int INHERITANCE_TYPE_NO_INHERITANCE

Not Implemented in CS Java Connector v3.0.

Value of 1; specifies no security inheritance. That is, this ACE (permission) on a Folder object will not be inherited by any containees of the Folder even if that Folder is the designated security parent of the containees.

See Also:
Constant Field Values

INHERITANCE_TYPE_THIS_OBJECT_AND_ALL_CONTAINED_OBJECTS

public static final int INHERITANCE_TYPE_THIS_OBJECT_AND_ALL_CONTAINED_OBJECTS

Not Implemented in CS Java Connector v3.0.

Value of 2; specifies that security is to be inherited by this object and all its contained objects.

See Also:
Constant Field Values

INHERITANCE_TYPE_FROM_SECURITY_POLICY

public static final int INHERITANCE_TYPE_FROM_SECURITY_POLICY

Not Implemented in CS Java Connector v3.0.

Value of 8; specifies that security was inherited from a security policy and not from a security parent.

See Also:
Constant Field Values

PERMISSION_SOURCE_DIRECT

public static final int PERMISSION_SOURCE_DIRECT
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; 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:
Constant Field Values

PERMISSION_SOURCE_DEFAULT

public static final int PERMISSION_SOURCE_DEFAULT
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; 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:
Constant Field Values

PERMISSION_SOURCE_TEMPLATE

public static final int PERMISSION_SOURCE_TEMPLATE
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; 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:
Constant Field Values

PERMISSION_SOURCE_PARENT

public static final int PERMISSION_SOURCE_PARENT
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; 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:
Constant Field Values

INHERITABLE_DEPTH_NO_INHERITANCE

public static final int INHERITABLE_DEPTH_NO_INHERITANCE
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 0; specifies that this permission cannot be inherited.

See Also:
Constant Field Values

INHERITABLE_DEPTH_ONE_LEVEL

public static final int INHERITABLE_DEPTH_ONE_LEVEL
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 1; specifies that this permission can be inherited by immediate security children but no further.

See Also:
Constant Field Values

INHERITABLE_DEPTH_UNLIMITED

public static final int INHERITABLE_DEPTH_UNLIMITED
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of -1; specifies that this permission can be inherited by security children to any depth.

See Also:
Constant Field Values

PERMISSION_TYPE_LEVEL

public static final int PERMISSION_TYPE_LEVEL
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 0; specifies a permission type for the described permission as an access level (that is, a bit mask of access rights). (See AccessPermission.getPermissionType().)

See Also:
Constant Field Values

PERMISSION_TYPE_LEVEL_DEFAULT

public static final int PERMISSION_TYPE_LEVEL_DEFAULT
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 1; specifies a permission type for the described permission as an access level default (LEVEL_FULL_CONTROL_DEFAULT, for example). (See AccessPermission.getPermissionType().)

See Also:
Constant Field Values

PERMISSION_TYPE_RIGHT

public static final int PERMISSION_TYPE_RIGHT
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 2; specifies a permission type for the described permission as a single access right (RIGHT_WRITE, for example). (See AccessPermission.getPermissionType().)

See Also:
Constant Field Values

PERMISSION_TYPE_RIGHT_INHERIT_ONLY

public static final int PERMISSION_TYPE_RIGHT_INHERIT_ONLY
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of 3; specifies a permission type for the described permission as applicable only to inheritable permissions. (See AccessPermission.getPermissionType().)

See Also:
Constant Field Values

PRINCIPAL_NAME_CREATOR_OWNER

public static final java.lang.String PRINCIPAL_NAME_CREATOR_OWNER
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "#CREATOR-OWNER"; specifies that the security principal name is the built-in group called CREATOR-OWNER.

See Also:
Constant Field Values

PRINCIPAL_NAME_AUTHENTICATED_USERS

public static final java.lang.String PRINCIPAL_NAME_AUTHENTICATED_USERS
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "#AUTHENTICATED-USERS"; specifies that the security principal name is the built-in group called AUTHENTICATED-USERS.

See Also:
Constant Field Values

PRINCIPAL_NAME_SPECIAL

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


PRINCIPAL_ID_CREATOR_OWNER

public static final java.lang.String PRINCIPAL_ID_CREATOR_OWNER
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "S-1-3-0"; specifies the security ID (SID) for the CREATOR-OWNER account.

See Also:
Constant Field Values

PRINCIPAL_ID_AUTHENTICATED_USERS

public static final java.lang.String PRINCIPAL_ID_AUTHENTICATED_USERS
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7; Value of "S-1-5-11"; specifies the security ID (SID) for the AUTHENTICATED-USERS account.

See Also:
Constant Field Values

PRINCIPAL_ID_SPECIAL

public static final java.lang.String[] PRINCIPAL_ID_SPECIAL
public static final int INHERITANCE_TYPE_OBJECT_INSTANCE = 7;

Method Detail

setAccessType

public void setAccessType(int accessType)

Not Implemented in CS Java Connector v3.0.

Sets the type of access to an object to be assigned to the user or group. For example, you can allow all users to read the contents of a document but allow only a limited number of users to make changes to the contents of that document. You must specify the access type permitted in the accessType argument. The valid constants and their integer values are:

Specifying TYPE_ALLOW or TYPE_DENY permits or prevents, respectively, access by the user or group to Content Services resources. A setting of TYPE_DENY on a group overrides a setting of TYPE_ALLOW for a given user. For example, if you deny RIGHT_WRITE access for a group, an individual user who has RIGHT_WRITE access but is a member of that group will be denied RIGHT_WRITE access.

To specify the permissions being allowed or denied by a call to setAccessType, call setAccess.

Parameters:
accessType - An integer that represents the access type to be set.

getAccessType

public int getAccessType()

Not Implemented in CS Java Connector v3.0.

Returns an integer that indicates whether a user or group is allowed or denied access. If the underlying Content Services permission object is an AuditPermission object, the results of this method are undefined.

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

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

setAccess

public void setAccess(int access)
Sets the access level (permissions) being granted or denied to a user or group. Access levels are defined as constants in the subinterface com.filenet.Panagon.Permission.

Parameters:
access - An integer that represents the access level being assigned.

getAccess

public int getAccess()
Returns an integer indicating the access level assigned to a user or group. Access levels are defined as constants in the subinterface com.filenet.Panagon.Permission.

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

Returns:
An integer representing the assigned access rights.

getGranteeType

public int getGranteeType()
Returns the object type of the permission grantee. The type is returned as an integer, which maps to one of two object types as defined in the BaseObject interface: 2000 (BaseObject.TYPE_USER) or 2001 (BaseObject.TYPE_GROUP).

Returns:
An integer representing the object type of the grantee.

getGranteeName

public java.lang.String getGranteeName()
Returns a String representing the name of the object being assigned permission. The returned String is the displayable user or group name that could appear in a user interface display. (To determine if the grantee is a user or group, call getGranteeType()).

Returns:
A String representing the object name.

isInherited

public boolean isInherited()

Not Implemented in CS Java Connector v3.0.

Returns true if the access rights granted by this Permission object were inherited from an object designated as the security parent or from a security policy; otherwise returns false. For example, a document can inherit the permissions of a folder in which it is filed. Access rights can also be inherited from a security template, which is part of a security policy. If isInherited() returns true, you can determine from which entity the permissions were inherited by calling getInheritanceType().

Returns:
true if permissions are inherited from the security parent or a security policy; otherwise, returns false.

setGranteeType

public void setGranteeType(int granteeType)
Sets the object type of the permission grantee. The valid integers for object type, as mapped in the BaseObject interface, are 2000 (BaseObject.TYPE_USER) and 2001 (BaseObject.TYPE_GROUP).

Parameters:
granteeType - An integer that represents the object type (user or group) of the grantee.

setGranteeName

public void setGranteeName(java.lang.String granteeName)
Sets the name of the object being granted permission.

Parameters:
granteeName - A String representing the grantee name.

setGrantee

public void setGrantee(SecurityGrantee grantee)
Sets the object type of the grantee. The parameter to this method is a SecurityGrantee object and is either a BaseObject.TYPE_USER or BaseObject.TYPE_GROUP.

Parameters:
grantee - A SecurityGrantee object that represents the grantee (a user or group).

setInheritanceType

public void setInheritanceType(int inheritanceType)
Deprecated. Use setInheritableDepth

Not Implemented in CS Java Connector v3.0.


getInheritanceType

public int getInheritanceType()
Deprecated. Use getInheritableDepth

Not Implemented in CS Java Connector v3.0.


getPermissionSource

public int getPermissionSource()

Not Implemented in CS Java Connector v3.0.

Returns an integer representing the source of this permission. The returned integer is the value of the read-only PermissionSource property.

A value of ... indicates that the permission was ...
0 (PERMISSION_SOURCE_DIRECT) directly assigned.
1 (PERMISSION_SOURCE_DEFAULT) acquired by default.
2 (PERMISSION_SOURCE_TEMPLATE) acquired from a security template.
3 (PERMISSION_SOURCE_PARENT) acquired from a security parent.

Returns:
An integer that defines the source of the permission.

getInheritableDepth

public int getInheritableDepth()

Not Implemented in CS Java Connector v3.0.

Returns an integer that represents the maximum number of levels (depth) through which this permission can be inherited. The returned integer is the value of the InheritableDepth property.

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.

setInheritableDepth

public void setInheritableDepth(int inheritableDepth)

Not Implemented in CS Java Connector v3.0.

Sets a value that represents the maximum number of levels (depth) through which this permission can be inherited. Calling this method sets the InheritableDepth property on this Permission object.

A value of ... sets the permission inheritance to ...
0 (INHERITABLE_DEPTH_NO_INHERITANCE) no inheritance. This permission cannot be inherited.
1 (INHERITABLE_DEPTH_ONE_LEVEL) one level. This permission can be inherited by only the immediate security child.
-1 (INHERITABLE_DEPTH_UNLIMITED) an infinite level. This permission can be inherited by any level of security child.

You can set inheritable depth on a Permission object only if its PermissionSource property is 0 or 1. If you attempt to set inheritable depth on a Permission object whose PermissionSource property value is 2 or 3, this method throws a SecurityInheritanceException. To determine the source type of the Permission object, call getPermissionSource().

Parameters:
inheritableDepth - An integer that specifies the inheritance depth for this Permission object. Use constants provided in this interface.

getSpecialPrincipalIds

public java.lang.String[] getSpecialPrincipalIds()

Not Implemented in CS Java Connector v3.0.

Returns the security IDs (SIDs) for the two built-in groups called CREATOR-OWNER and AUTHENTICATED-USERS.

This method allocates a new String[] with the same contents for each caller (each caller gets a reference to a different array). In this way, changes to the array contents made by one caller do not affect other callers of this method.

Note that to call this method, you must have an available instance of the Permission object. If one is not immediately available, you can instantiate one for this call in the following manner:

String[] foo = ObjectFactory.getPermission(0, Permission.TYPE_ALLOW, "",
   BaseObject.TYPE_USER).getSpecialPrincipalIds();

Returns:
A String array of principal IDs for built-in groups.

FileNet Content Services
Java Connector v3.0