FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface ActiveMarking

All Superinterfaces:
java.io.Serializable, ValueObject

public interface ActiveMarking
extends ValueObject, java.io.Serializable

Not Implemented in CS Java Connector v3.0.

An ActiveMarking object represents a marking that is currently assigned to an object. For a list of objects to which a marking can be assigned, refer to the Marking interface.

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. The list of all markings assigned to a single object is represented by an ActiveMarkings collection.

You cannot create an ActiveMarking object with the Content Services Java Connector. However, you can instantiate one by retrieving an object's ActiveMarkings property, then retrieving an item from the collection using an approach of your choice.

Using the methods on this interface, you can retrieve markings that have been applied to an object, and you can retrieve information related to an active marking (for example, its class ID).


Method Summary
 java.lang.String getClassId()
          

Not Implemented in CS Java Connector v3.0.

 Marking getMarking()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getPropertyDisplayName()
          

Not Implemented in CS Java Connector v3.0.

 

Method Detail

getClassId

public java.lang.String getClassId()

Not Implemented in CS Java Connector v3.0.

Returns the ID of the class description of this ActiveMarking object.

Returns:
A String that represents the ID of the class description of this ActiveMarking object.

getPropertyDisplayName

public java.lang.String getPropertyDisplayName()

Not Implemented in CS Java Connector v3.0.

Returns the display name of the associated property on an object to which this ActiveMarking object has been assigned.

This method is useful for determining which property is associated with each marking in an object's active markings collection. As an example, assume the marking value is "Red" and the object to which this marking has been assigned is a Car object. The Car object has a custom property whose display name is "Color" and the marking was associated with that Color property when the marking was created. Calling this method would then return a string containing "Color".

Returns:
A String that represents a property's display name.

getMarking

public Marking getMarking()

Not Implemented in CS Java Connector v3.0.

Returns a Marking object that is currently assigned to an object. From the returned Marking object, you can call methods to retrieve information about the marking, such as its ID, display name, and so on.

Returns:
A Marking object.

FileNet Content Services
Java Connector v3.0