com.filenet.api.security

Interface VersioningSecurityTemplate

  • All Superinterfaces:
    DependentObject, EngineObject, RepositoryObject, SecurityTemplate, java.io.Serializable

    public interface VersioningSecurityTemplate
extends RepositoryObject, SecurityTemplate, DependentObject
    Represents a template for automatically applying permissions (access rights) to a Document object during versioning state changes. Security templates are not independently persistable to the Content Engine; they are contained in a SecurityPolicy object. The template contains the permissions that will be applied to an object as its version state changes. A VersioningSecurityTemplate object also has associated AccessPermissionDescription objects, each of which provide descriptive information for an access right or level.

    You can enable or disable a template within its security policy container. An enabled template can be applied to an object; a disabled template remains an item in the security policy container but cannot be applied to an object.

    A SecurityTemplate object can represent either an application security template or a versioning security template, and both types can exist simultaneously in a single SecurityPolicy object. The two template types are differentiated by their use and by their class IDs (GUIDs). An application security template must be explicitly applied by calling an object's applySecurityTemplate method; it is never automatically applied. A versioning security template is automatically applied when the state of a document version changes, and may also be explicitly applied at any time by a user or group with permission to modify the object's security (AccessRight.WRITE_ACL).

    If an object has no associated security policy, its permissions remain unchanged when it undergoes a versioning change. However, if the object has an associated SecurityPolicy object, its permissions are modified according to the non-disabled, applicable security templates of its SecurityPolicy when:

    • The object undergoes a versioning change (for example, a document's version status moves from in-process to released).
    • The object's class changes (as the result of a call to the object's changeClass method).

    To create a new VersioningSecurityTemplate object, call createInstance on the Factory.VersioningSecurityTemplate class. To retrieve a VersioningSecurityTemplate object from a SecurityPolicy object, first retrieve the SecurityPolicy object's SecurityTemplates property then retrieve a SecurityTemplate object of the desired type from the returned SecurityTemplates collection.

    Metadata

    Auditable: false
    AllowsInstances: true
    AllowsSubClasses: false
    ClassDefinitionName: None
    IsDependent: true
    IsHidden: false
    Searchable: false
    StorageType: ObjectStore
    SuperclassName: SecurityTemplate
  • Summary: 
  • Nested | 
  • Field | 
  • Constr | 
  • Method
  • Detail: 
  • Field | 
  • Constr | 
  • Method

© Copyright IBM Corporation 2006, 2013. All rights reserved.