FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface Marking

All Superinterfaces:
java.io.Serializable, ValueObject

public interface Marking
extends ValueObject, java.io.Serializable

Not Implemented in CS Java Connector v3.0.

A Marking object represents a single item in a set of markings. For example, if a set of markings is called Security Codes, items within the set might be Top Secret, Secret, Confidential, and so on. To provide another level of security on the object, you can assign one or more of these markings to an object. To then be able to access that object, a user must be granted sufficient access from all assigned markings.

Objects to which markings can be assigned are: Annotation, CustomObject, Custom Events (that is, Event objects of class "Custom Event"), Document, EventAction, Folder, Link, PublishTemplate, SecurityPolicy, StoredSearch, StyleTemplate, Subscription, and WorkflowDefinition.

You cannot create a Marking object but you can instantiate one in the following ways:


Method Summary
 int getAccessMask()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getClassId()
          

Not Implemented in CS Java Connector v3.0.

 int getConstraintMask()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getId()
          

Not Implemented in CS Java Connector v3.0.

 java.lang.String getMarkingValue()
          

Not Implemented in CS Java Connector v3.0.

 Permissions getPermissions()
          

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 Marking object.

Returns:
A String representing the class description ID of this object.

getId

public java.lang.String getId()

Not Implemented in CS Java Connector v3.0.

Returns the Marking object's ID. The ID is a GUID (the value of the object's Id property).

Returns:
A String representing the ID of this object.

getMarkingValue

public java.lang.String getMarkingValue()

Not Implemented in CS Java Connector v3.0.

Returns the value that is associated with this Marking object. A marking is assigned to an object by setting the object's String-valued property that has been associated with the marking set. For example, if the value of a marking is "Confidential", the string returned by this method will contain "Confidential".

Returns:
A String representing this marking's value.

getPermissions

public Permissions getPermissions()

Not Implemented in CS Java Connector v3.0.

Returns the set of permissions associated with this Marking object. Marking permissions control access to the object on which the marking is applied. Use the permissions to determine:

To determine the access rights, iterate through the returned collection and retrieve each Permission object. Then call getAccess() on each Permission object to determine the access right associated with the grantee. For example, if the grantee has been granted Add (RIGHT_ADD_MARKING) or Remove (RIGHT_REMOVE_MARKING) permission, that user or group is allowed to, respectively, assign this marking to an object or remove this marking from an object. If the grantee has been granted Use permission (RIGHT_USE_MARKING), then that user or group is authorized to access the object to which this marking has been assigned.

Returns:
A Permissions collection containing the Permission objects associated with this Marking object.

getConstraintMask

public int getConstraintMask()

Not Implemented in CS Java Connector v3.0.

Returns a value that represents the set of access rights affected by this Marking object when it is assigned to an object. A constraint mask is used to remove any access rights to an object when this marking is assigned. For example, if you assign a marking to an object, and the marking's permissions have not granted the user or group the "Use" access right (Permission.RIGHT_USE_MARKING), then the rights represented by bits in the constraint mask are subtracted (removed) from the preliminary Effective Access Mask that was computed by the authorization service. The computed result of this subtraction is the Effective Access Mask for the object.

Returns:
An integer that represents a bit mask of access rights. The integer represents any combination of Permission.RIGHT_XXX values. For example, a value of 0xFFFFFFFF indicates that all access rights in the constraint mask will be removed from the preliminary Effective Access Mask, resulting in a computed Effective Access Mask that prevents all access to the object in question.

getAccessMask

public int getAccessMask()

Not Implemented in CS Java Connector v3.0.

Returns the effective mask for this Marking object based on the current user and the Marking object's permissions. (The current user is identified in the Session object.) Use the returned integer to determine if a given user has the appropriate rights to perform marking-related operations on an object.

Possible return values are 0, Permission.RIGHT_ADD_MARKING, Permission.RIGHT_USE_MARKING, Permission.RIGHT_REMOVE_MARKING, or combinations of these values. For example, if this method returns Permission.RIGHT_ADD_MARKING, you know that the current user has the right to assign this marking to an object. If this method returns 0, the user cannot add the marking to or remove the marking from an object, and is not granted Use privileges if the marking is assigned to an object. In this case, if this was the only marking assigned to an object, the object's Effective Access Mask would deny access to those rights defined by the marking's constraint mask.

Returns:
An integer that represents the Effective Access Mask for this Marking object.

FileNet Content Services
Java Connector v3.0