com.filenet.api.security
Interface ActiveMarking

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

public interface ActiveMarking
extends RepositoryObject, EngineObject, DependentObject

Represents a marking that is currently applied to a given object.

Any object that can have a marking can be assigned one or more markings. A marking that is assigned to an object is called an active marking. An ActiveMarkingList collection contains all markings assigned to a single object.

Using the methods on this interface, you can retrieve the value of the associated Marking property, and the display name of the property to which the active marking applies. (See the PropertyDisplayName property.)

You cannot create a new ActiveMarking object. However, you can get a reference to one by retrieving an object's ActiveMarkings property, the value of which is an ActiveMarkingList, and then retrieving an item from the returned collection using an approach of your choice.

Metadata

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


Method Summary
 Marking get_Marking()
          Returns the value of the Marking property.
 java.lang.String get_PropertyDisplayName()
          Returns the value of the PropertyDisplayName property.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Marking

Marking get_Marking()
Returns the value of the Marking property. For more information, see Marking Property.


get_PropertyDisplayName

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



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