com.filenet.api.security
Interface SecurityPolicy

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, Replicable, RepositoryObject, java.io.Serializable, Subscribable

public interface SecurityPolicy
extends RepositoryObject, Replicable, Subscribable, IndependentlyPersistableObject

Represents an independently persistable, subclassable container for a list of security templates. Through an object's SecurityPolicy property, a SecurityPolicy object is associated with a Document, CustomObject, or Folder object, and subclasses of those objects. When you create an object of one of these types, you can optionally assign a SecurityPolicy object to it. If not explicitly assigned, the object's SecurityPolicy property is assigned a value provided by the class's default.

The security policy defines the set of security templates that can be applied to the objects with which the policy is associated. The templates contained within a security policy can be one of two types: versioning or application templates. (For more information on security template types, see SecurityTemplate.)

You can create an instance of a SecurityPolicy object by calling createInstance methods on the Factory.SecurityPolicy class. A SecurityPolicy object can be retrieved from the object-valued SecurityPolicy property on a Containable object. (You cannot create a SecurityPolicy instance by retrieving it from the SecurityPolicy property.)

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: ReplicableClassDefinition
IsDependent: false
IsHidden: false
Name: DisplayName
Searchable: true
StorageType: ObjectStore
SuperclassName: Replicable


Method Summary
 ActiveMarkingList get_ActiveMarkings()
          Returns the value of the ActiveMarkings property.
 EventSet get_AuditedEvents()
          Returns the value of the AuditedEvents property.
 java.lang.String get_Creator()
          Returns the value of the Creator property.
 java.util.Date get_DateCreated()
          Returns the value of the DateCreated property.
 java.util.Date get_DateLastModified()
          Returns the value of the DateLastModified property.
 java.lang.String get_DescriptiveText()
          Returns the value of the DescriptiveText property.
 java.lang.String get_DisplayName()
          Returns the value of the DisplayName property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 java.lang.String get_Name()
          Returns the value of the Name property.
 java.lang.String get_Owner()
          Returns the value of the Owner property.
 AccessPermissionList get_Permissions()
          Returns the value of the Permissions property.
 java.lang.Boolean get_PreserveDirectPermissions()
          Returns the value of the PreserveDirectPermissions property.
 SecurityTemplateList get_SecurityTemplates()
          Returns the value of the SecurityTemplates property.
 void set_Creator(java.lang.String value)
          Sets the value of the Creator property.
 void set_DateCreated(java.util.Date value)
          Sets the value of the DateCreated property.
 void set_DateLastModified(java.util.Date value)
          Sets the value of the DateLastModified property.
 void set_DescriptiveText(java.lang.String value)
          Sets the value of the DescriptiveText property.
 void set_DisplayName(java.lang.String value)
          Sets the value of the DisplayName property.
 void set_LastModifier(java.lang.String value)
          Sets the value of the LastModifier property.
 void set_Owner(java.lang.String value)
          Sets the value of the Owner property.
 void set_Permissions(AccessPermissionList value)
          Sets the value of the Permissions property.
 void set_PreserveDirectPermissions(java.lang.Boolean value)
          Sets the value of the PreserveDirectPermissions property.
 void set_SecurityTemplates(SecurityTemplateList value)
          Sets the value of the SecurityTemplates property.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.replication.Replicable
get_ExternalReplicaIdentities, get_ReplicationGroup, set_ExternalReplicaIdentities, set_ReplicationGroup
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Creator

java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.


set_Creator

void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.


get_DateCreated

java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.


set_DateCreated

void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.


get_LastModifier

java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.


set_LastModifier

void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.


get_DateLastModified

java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.


set_DateLastModified

void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.


get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_Name

java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name Property.


get_AuditedEvents

EventSet get_AuditedEvents()
Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.


get_Owner

java.lang.String get_Owner()
Returns the value of the Owner property. For more information, see Owner Property.


set_Owner

void set_Owner(java.lang.String value)
Sets the value of the Owner property. For more information, see Owner Property.


get_Permissions

AccessPermissionList get_Permissions()
Returns the value of the Permissions property. For more information, see Permissions Property.


set_Permissions

void set_Permissions(AccessPermissionList value)
Sets the value of the Permissions property. For more information, see Permissions Property.


get_ActiveMarkings

ActiveMarkingList get_ActiveMarkings()
Returns the value of the ActiveMarkings property. For more information, see ActiveMarkings Property.


get_DisplayName

java.lang.String get_DisplayName()
Returns the value of the DisplayName property. For more information, see DisplayName Property.


set_DisplayName

void set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property. For more information, see DisplayName Property.


get_DescriptiveText

java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.


set_DescriptiveText

void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.


get_SecurityTemplates

SecurityTemplateList get_SecurityTemplates()
Returns the value of the SecurityTemplates property. For more information, see SecurityTemplates Property.


set_SecurityTemplates

void set_SecurityTemplates(SecurityTemplateList value)
Sets the value of the SecurityTemplates property. For more information, see SecurityTemplates Property.


get_PreserveDirectPermissions

java.lang.Boolean get_PreserveDirectPermissions()
Returns the value of the PreserveDirectPermissions property. For more information, see PreserveDirectPermissions Property.


set_PreserveDirectPermissions

void set_PreserveDirectPermissions(java.lang.Boolean value)
Sets the value of the PreserveDirectPermissions property. For more information, see PreserveDirectPermissions Property.



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