This topic alphabetically lists the properties that apply to the CustomObject class.
ActiveMarking
objects currently applied to a given object.
Each ActiveMarking
object represents a marking that is in a MarkingSet
associated
with a property on the object.
AnnotationSet
object that contains the annotations associated with this object.
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
CmHoldRelationship
objects associated with this object.
IndexingFailureCode
constants that identify the types of indexing failures that have occurred
as a result of an index request for a CBR-enabled object. If there are no indexing failures, the CmIndexingFailureCode
property returns a value of zero.
If you set the value of the IndexingFailureRecordingLevel property of an ObjectStore
object to PROPAGATE_TO_SOURCE
,
the error information is propagated to the CmIndexingFailureCode property of all CBR-enabled objects.
true
, the object
is the original object explicitly marked for deletion by a user, or the object is referenced by the
original object through an object-valued property (OVP), and, therefore, was marked for
deletion by the server.
Objects marked for deletion are represented by a CmRecoveryItem
object, through which the objects can be either recovered or purged (removed from the
object store database).
null
,
this object is not held under retention and there are no restrictions on when it can be deleted.
When you create an object, the Content Engine server automatically sets the CmRetentionDate property to the default retention date and time. The Content Engine server calculates the default retention date and time by adding the retention period (DefaultRetentionPeriod property of the object's class definition) expressed in the selected duration units (RetentionPeriodUnits property of the object's class definition) to the date and time when the object was created. Alternatively, you can override the default value by setting the CmRetentionDate property of the object to a specific date and time. Once an object has been created, you cannot change the value of its CmRetentionDate property to a smaller value; that is, the retention period of the object cannot be shortened.
An object that has related objects under retention cannot be deleted until all of its related objects have been deleted. For example, a document with annotations cannot be deleted until all of its annotations have been deleted. The retention dates of a document and its annotations are independent of each other.
When a document is checked out, its CmRetentionDate property value is not applied to the resulting reservation object. If you set the CmRetentionDate property of the reservation object, the property value is applied to the new document version when you check in the reservation object. Note that setting the CmRetentionDate property of the reservation object does not prevent the reservation object from being deleted. If you do not set the CmRetentionDate property of the reservation object when you check it in, the CmRetentionDate property of the new document version is automatically set to the default retention date and time.
The CmRetentionDate property can be set to a specific date and time, or it can be set to one of the following RetentionConstants
constants:
INDEFINITE
: Indefinite retention. Specifies that the object can be deleted only if the CmRetentionDate
property is changed to an expiration date and time, and that date and time is in the past. This property can be set
to INDEFINITE
only if it has a value of null
. If this property has been set to INDEFINITE
,
it cannot be set to null
; it can only be set to a date and time value or to PERMANENT
.PERMANENT
: Permanent retention. Specifies that the object can never be deleted. To set the CmRetentionDate property value on an object, you must have the following permissions:
ReferentialContainmentRelationshipSet
collection object containing the
ReferentialContainmentRelationship
objects that identify the containers of this object.
Containable
object.
Each CmTask
object in the enumeration represents a single piece of work in a business process.
A CmTask
object with a Coordinator
property set to this Containable
object is added to the enumeration value of this property.
Settability of this property is read-only for most users. For users who have been
granted privileged write access (AccessRight.PRIVILEGED_WRITE
), this property is
settable only on create. After initial object creation, this property is read-only for all users.
Settability of this property is read-only for most users. For users who have been
granted privileged write access (AccessRight.PRIVILEGED_WRITE
), this property is
settable only on create. After initial object creation, this property is read-only for all users.
Settability of this property is read-only for most users. For users who have been granted privileged
write access (AccessRight.PRIVILEGED_WRITE
), this property is read/write. (The read/write access for those
users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that
object store).
ExternalIdentityList
collection of the read-only ExternalIdentity
objects
that represent the identities of replicas of this object in external repositories.
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:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.
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.
null
for objects that are full-text indexed prior to the 4.0 release.
The server sets this property if a string-valued property of this object is CBR-enabled.
An object is considered to be CBR-enabled if you set the PropertyDefinitionString.IsCBREnabled
property of the property definition of one of the object's string-valued properties to true
.
Settability of this property is read-only for most users. For users who have been granted privileged
write access (AccessRight.PRIVILEGED_WRITE
), this property is read/write. (The read/write access for those
users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that
object store).
lock
method.
The value of this property is simply a custom string that has no real effect in determining the user of the lock.
The owner specified by this property is not validated against any user or group known to the Content Engine.
This property is set to null
if the unlock
method is called; if the lock expires naturally,
then the value remains unchanged.
lock
method; however, the value can be updated by a call to updateLock
.
The property value is the number of seconds beyond the value in the object's DateLastModified property that
the user of the lock can hold the lock on the object. The result of the calculation is measured against the current
system time. The lock is considered expired when the value of the object's DateLastModified property
plus the value of the LockTimeout property is less than the current system time. (All millisecond
components are dropped from the calculation.) This property is set to null
if the unlock
method is called; if the lock expires naturally, then the value remains unchanged.
unlock
), the value of LockToken
is set to null
.
(If the lock expires naturally, then the value remains unchanged.)
For most classes, this property is read-only and returns the value of the designated name property for the object,
or its ID if there is no name property. If ClassDescription.NamePropertyIndex
has a value,
this property contains the value of the designated name property. If there is no designated name property value, and
the object has an Id property, this property contains the string value of the Id property. If neither of these conditions
is satisfied, this property contains an empty string.
For a ComponentRelationship
object, this property is read/write and specifies the name of the object.
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
ReplicationJournalEntry
objects only, this property represents the replication group
to which the source object of the replication operation generating this journal entry belongs.
Folder
object from which the object inherits security (a security parent).
This value is indirectly set when DefineSecurityParentage is specified as the value of the defineSecurityParentage
parameter for the Folder.file
method.
The value, in this case, is the folder in which the object is filed.
You can designate multiple security parents for an object by using one or more object-valued properties
and setting the SecurityProxyType
value for these properties to INHERITANCE
.
Deprecated. Use SecurityFolder
instead.
ReferentialContainmentRelationship
(or DynamicReferentialContainmentRelationship
)
that represents the object from which security is inherited.
An object can inherit its permissions from its security parent. For example, a Document
object can inherit the permissions of the Folder
in which it is filed. A Folder
object always
inherits its permissions from its parent folder. An object's security parent is reflected in the value of its
SecurityParent
property. You can explicitly set the security parent of an object at the time it is filed
into a folder by specifying the defineSecurityParentage
parameter of the Folder.file
method.
SecurityPolicy
associated with the given object. The SecurityPolicy
contains one or more SecurityTemplate
objects that define the permissions to assign to a given
object. A security template can be one of two types: a VersioningSecurityTemplate
or an
ApplicationSecurityTemplate
. A VersioningSecurityTemplate
defines permissions that will be
automatically assigned to the object when its version state changes. An ApplicationSecurityTemplate
defines permissions that will be assigned to the object upon an explicit call to do so by an application
program. For information on each of these types of templates, refer to their interface descriptions.
Assigning a security policy to a Document
, CustomObject
, or Folder
object
(or their subclasses) is optional.