Represents the definition of a value that may be assigned to a marking-controlled property. Markings provide an additional, optional layer of security that is primarily designed for the records management marketplace, but which can also be applied by non-records management applications. Markings allow controlled access to objects based on specific property values. The set of definitions for all possible Marking objects is contained in a MarkingSet collection.

A marking 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. Each of those marking values 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 the value is assigned, who will have access to the object to which the value is assigned. 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. The set of all active markings (that is, those that are currently assigned to a given object) are contained in an ActiveMarkingList collection. To retrieve the active markings on a given object, get the value of its ActiveMarkings property. You can then retrieve each marking and its value.

The user's access to an object is represented by an effective access mask. The effective access is calculated using the object's permission list and subtracting the constraint mask of the applied markings. The resulting effective access is used to control what that user can do with the object.


Namespace: FileNet.Api.Security
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Interface IMarking
    Implements IEngineObject, ICloneable, IDependentObject
C#
public interface IMarking : IEngineObject, ICloneable, IDependentObject
C++
interface class IMarking : IEngineObject, ICloneable, IDependentObject
J#
public interface IMarking implements IEngineObject, ICloneable, IDependentObject
JScript
public interface IMarking extends IEngineObject, ICloneable, IDependentObject

Remarks

Metadata

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

See Also