com.filenet.api.security

Interface AccessPermissionDescription

All Superinterfaces:

DependentObject, EngineObject, PermissionDescription, java.io.Serializable

public interface AccessPermissionDescription
extends PermissionDescription, DependentObject

Describes an access right or level. This interface provides 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 PermissionDescriptionList 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 (AccessRight.READ) permission on the parent object to be able to retrieve the permission description information.

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

• By iterating an AccessPermissionDescriptionList collection.
• By calling SecurityTemplate.get_TemplatePermissionDescriptions.
• By calling ClassDescription.get_PermissionDescriptions.

These methods return an AccessPermissionDescriptionList collection from which you can retrieve an AccessPermissionDescription object.

Metadata

Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain or ObjectStore
SuperclassName: PermissionDescription

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Integer	get_AccessMask() Returns the value of the AccessMask property.
PermissionType	get_PermissionType() Returns the value of the PermissionType property.

Methods inherited from interface com.filenet.api.security.PermissionDescription

get_DescriptiveText, get_DisplayName

Methods inherited from interface com.filenet.api.core.EngineObject

get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

Method Detail

get_AccessMask

java.lang.Integer get_AccessMask()

Returns the value of the AccessMask property. For more information, see AccessMask Property.

get_PermissionType

PermissionType get_PermissionType()

Returns the value of the PermissionType property. For more information, see PermissionType Property.