com.filenet.api.security
Interface MarkingSet

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable

public interface MarkingSet
extends IndependentlyPersistableObject

Represents a container for the set of markings for a given object property.

The MarkingSet collection contains Marking objects. Each Marking object represents a possible value that can be applied to an object property. Each marking value contains a set of access permissions that define who can assign that specific value to an object property, who can modify or remove that specific value, and, once it is assigned, who will have access to the object it is assigned to.

The marking set is assigned to a property definition on a class such that the value of that property on instances of the class must be one of the markings defined by the marking set. Values can only be assigned by users authorized by the associated marking, and, after the marking is applied, access to the object is restricted based on the marking.

You can create a new MarkingSet collection by calling Factory.MarkingSet.createInstance, or retrieve an existing instance by calling getInstance or fetchInstance.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject


Method Summary
 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.Boolean get_IsHierarchical()
          Returns the value of the IsHierarchical property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 MarkingList get_Markings()
          Returns the value of the Markings 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_IsHierarchical(java.lang.Boolean value)
          Sets the value of the IsHierarchical property.
 void set_Markings(MarkingList value)
          Sets the value of the Markings property.
 
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.


get_DateCreated

java.util.Date get_DateCreated()
Returns 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.


get_DateLastModified

java.util.Date get_DateLastModified()
Returns 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_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_IsHierarchical

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


set_IsHierarchical

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


get_Markings

MarkingList get_Markings()
Returns the value of the Markings property. For more information, see Markings Property.


set_Markings

void set_Markings(MarkingList value)
Sets the value of the Markings property. For more information, see Markings Property.



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