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
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 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
collection.AccessPermissionDescriptionList - By retrieving the
property from aTemplatePermissionDescriptions
object.SecurityTemplate - By retrieving the
property from aPermissionDescriptions
object.ClassDescription
These methods return an
collection from which you can retrieve an
object.
Namespace: FileNet.Api.Security
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Public Interface IAccessPermissionDescription Implements IPermissionDescription, IEngineObject, ICloneable, IDependentObject |
C# |
---|
public interface IAccessPermissionDescription : IPermissionDescription, IEngineObject, ICloneable, IDependentObject |
C++ |
---|
interface class IAccessPermissionDescription : IPermissionDescription, IEngineObject, ICloneable, IDependentObject |
J# |
---|
public interface IAccessPermissionDescription implements IPermissionDescription, IEngineObject, ICloneable, IDependentObject |
JScript |
---|
public interface IAccessPermissionDescription extends IPermissionDescription, IEngineObject, ICloneable, IDependentObject |
Remarks
Metadata
Auditable: false
AllowsInstances: false
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: true
IsHidden: false
Searchable: false
StorageType: Domain or ObjectStore
SuperclassName: PermissionDescription