FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface AccessPermissionDescription

All Superinterfaces:
java.io.Serializable, ValueObject

public interface AccessPermissionDescription
extends ValueObject, java.io.Serializable

Not Implemented in CS Java Connector v3.0.

The AccessPermissionDescription interface supplies helper methods that you can use to retrieve descriptive information for a particular access right or access level (a commonly-used combination of access rights) for a particular object. The most typical use of this interface's methods is to populate a security edit dialog. For example, you can retrieve a PermissionDescriptions collection for an object, then use these methods to list the access rights and levels that a user can add. You can also retrieve the display name, descriptive text, and the permission type for the object.

The user must have Read permission (either Permission.LEVEL_READ or Permission.RIGHT_READ) on the parent object (for example, SecurityPolicy object) to retrieve the permission description information.

You can get an instance of this object in the following ways:

For code examples, refer to Working with Security.


Method Summary
 int getAccessMask()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getDescriptiveText()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getDisplayName()
          

Not Implemented in CS Java Connector v3.0.

 int getPermissionType()
          

Not Implemented in CS Java Connector v3.0.

 

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Not Implemented in CS Java Connector v3.0.

Returns the display name of this described permission.

Returns:
A String containing the display name of the permission.

getDescriptiveText

public java.lang.String getDescriptiveText()

Not Implemented in CS Java Connector v3.0.

Returns a description of this permission.

Returns:
A String containing the text that describes the permission.

getAccessMask

public int getAccessMask()

Not Implemented in CS Java Connector v3.0.

Returns the bit mask for the access rights, or the value of a single access right, for this described permission. The returned access mask indicates the set of access rights (level) or single access right granted to the current user (that is, the user identified in the Session object). For example, if this method returns 1, you know that the permission described by this AccessPermissionDescription object is for viewing the properties of an object (Permission.RIGHT_READ).

Returns:
An integer that represents either the access bit mask or the value of the single access right.

getPermissionType

public int getPermissionType()

Not Implemented in CS Java Connector v3.0.

Returns an enumerated value for the permission type of this described permission.

The possible values (0 through 3) returned by this method indicate the permission type for the described permission. The values are defined as constants in the Permission interface, and are described briefly in the table below.

Name Value Indicates that ...
PERMISSION_TYPE_LEVEL 0 This description is of an access level (a commonly used combination of access rights) and the bit mask is likely to have multiple bits set.
PERMISSION_TYPE_LEVEL_DEFAULT 1 This description is of an access level default, which is the recommended set of access rights for new access permissions.
PERMISSION_TYPE_RIGHT 2 This description is of a single access right (one bit in the access mask) that is relevant both to the object to which this description applies and potentially to (security) children of that object.
PERMISSION_TYPE_RIGHT_INHERIT_ONLY 3 This description is only applicable to inheritable permissions. The access right is not directly relevant to the object to which this description applies, but is relevant to some children of that object.

For more information on permission descriptions, refer to Security Concepts.

Returns:
An integer that represents the permission type.

FileNet Content Services
Java Connector v3.0