Marking Properties

This topic alphabetically lists the properties that apply to the Marking class.

ClassDescription Property



Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ConstraintMask Property



A bitmask defining the access permission associated with a given marking.

If a given user does not have the appropriate rights to perform marking-related operations on the object, the access rights specified in the marking's ConstraintMask property are removed from the user's access rights for that object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: 4294967295
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Id Property



A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

MarkingUseGranted Property



Contains a bit mask that identifies which access rights have been granted to the current user. A user can be granted "Use", "Remove", and "Add" rights. The "Remove" and "Add" rights determine if the current user can remove or add a marking value on an independent object.

The primary use of the MarkingUseGranted property is to detect whether the current user has the "Use" right. The "Use" right determines whether the presence of the marking on an object constrains access to that object. If the user has "Use" right to the marking, access to associated independent objects will not be constrained by the value of the ConstraintMask property on the Marking object. The absence of the "Use" right means that the values in the ConstraintMask property will be subtracted from the associated object's effective access calculation (which is the value returned by the IndependentlyPersistableObject.getAccessAllowed() method). In this case, the constraint mask of the marking identifies which rights cannot be granted, and will be ignored, which effectively removes those rights granted on the associated independent object's ACL.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

MarkingValue Property



Specifies the value to use when applying a Marking to an object that has a property associated with a MarkingSet. This value of a marking must be unique within a marking set.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Permissions Property



Manages the discretionary permissions assigned to the object.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: DiscretionaryPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ