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 retrieving the TemplatePermissionDescriptions property from a SecurityTemplate object.
  • By retrieving the PermissionDescriptions property from a ClassDescription object.

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

Namespace:  FileNet.Api.Security
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Public Interface IAccessPermissionDescription _
	Implements IPermissionDescription, IEngineObject, ICloneable, IDependentObject
C#
public interface IAccessPermissionDescription : IPermissionDescription, 
	IEngineObject, ICloneable, IDependentObject
Visual C++
public interface class IAccessPermissionDescription : IPermissionDescription, 
	IEngineObject, ICloneable, IDependentObject
JavaScript
FileNet.Api.Security.IAccessPermissionDescription = function();
FileNet.Api.Security.IAccessPermissionDescription.createInterface('FileNet.Api.Security.IAccessPermissionDescription');

ToggleRemarks

Metadata

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

ToggleSee Also