|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersioningSecurityTemplate
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 have the same object type, but are differentiated by their use and by their
class IDs (GUIDs), which are available as constants defined in the VersionStatusId
class.
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:
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
Method Summary |
---|
Methods inherited from interface com.filenet.api.security.SecurityTemplate |
---|
get_ApplyStateID, get_DisplayName, get_Id, get_IsEnabled, get_TemplatePermissionDescriptions, get_TemplatePermissions, set_ApplyStateID, set_DisplayName, set_IsEnabled, set_TemplatePermissions |
Methods inherited from interface com.filenet.api.core.EngineObject |
---|
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses |
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |