This topic alphabetically lists the properties that apply to the CodeModule 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.
DocumentSet collection object that contains the child Document
objects bound to this parent document. The collection contains only those child documents for which the
user has read access. For each ComponentRelationship object that references
this document as the parent component document, the collection contains the version of the child
component document that is bound to this parent document. The same child document can be in the
collection more than once.
For information on the ordering of the collection, see ComponentSortOrder Property.
ComponentRelationshipSet collection object that contains the ComponentRelationship
objects referencing this document as the parent component document.
For information on the ordering of the collection, see ComponentSortOrder Property.
ClassDescription object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
DocClassificationStatus constant that indicates the auto-classification status for this document.
The ClassificationStatus property is used to provide client applications a means of discovering whether a particular
document is subject to auto-classification, and if so, whether or not the operation was successful.
This property can hold one of the following values:
CLASSIFICATION_COMPLETE: Indicates that document auto-classification has completed successfully.CLASSIFICATION_FAILED: Indicates that document auto-classification has failed.CLASSIFICATION_PENDING: Indicates that a request for document auto-classification is pending. This value is
set automatically by the server when you check in a document and set the checkin method's
autoClassify parameter to AUTO_CLASSIFY.NOT_CLASSIFIED: Indicates that document auto-classification has not been requested. This value is set
automatically by the server when you check in a document and set the checkin method's autoClassify
parameter to DO_NOT_AUTO_CLASSIFY.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:
Valid settings are:
COMPOUND_DOCUMENT: Designates the document as the parent component in a
compound document. Initially, this parent document has no child components. A document must be
designated as a compound document to become a parent component for a ComponentRelationship object.STANDARD_DOCUMENT (default setting - 4.0.x release): Designates the document
as a standard document. This setting prevents the document from being a parent component within a
compound document. A document cannot be designated as a standard document when referenced as
a parent component by a ComponentRelationship object.null (default setting - 3.5.x upgraded to 4.0.x): Designates the document as a
standard document. By default, pre-existing documents in an object store upgraded to 4.0.x return a null
value instead of STANDARD_DOCUMENT. Note that, although a null
value can be returned, you cannot set this property to null.ReferentialContainmentRelationshipSet collection object containing the
ReferentialContainmentRelationship objects that identify the containers of this object.
ContentElementList object containing the list of content elements associated with
this document or annotation. Each content element represents content data, which can either be local
to an object store and stored in a file store or database (represented by a ContentTransfer object)
or external to an object store and therefore outside the control of the Content Engine server
(represented by a ContentReference object).
StringList object containing the MIME type of each content element
associated with this document or annotation at the time it was last saved.
This property is maintained for backward compatibility and is automatically populated by the server with the same value as the document’s CmRetentionDate property.
ContentTransfer object.
Note that if the document or annotation has more than one content element, then the size is the sum of all of the content elements.
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.
DocumentState object representing the
current lifecycle state of this document.
The server sets this property on a document version when it is checked in and it remains set throughout the life of the document version. When a document is checked out, the server sets this property on the document's reservation object to null.
Settability of this property is read-only for most users. Users who have been granted
privileged write access (AccessRight.PRIVILEGED_WRITE) can set this property
on a document while it is being checked in. Note that although the settability of this property
for users with privileged write access is SETTABLE_ONLY_BEFORE_CHECKIN,
those users can not set this property on a document prior to check in; it can be set only
while a document is being checked in.
ContentTransfer object) associated
with this document or annotation was last accessed. The Content Engine stores dates and times using
Coordinated Universal Time (UTC). For more information, see
Timestamps.
The recording granularity of the date and time returned by this property is determined by the setting of the object store's ContentAccessRecordingLevel property. The content data associated with a document or annotation object is considered to be accessed when one of the following events occur:
refresh method is called with the property filter set to refresh PropertyContent properties
(FilteredPropertyType.CONTENT_DATA).accessContentStream method is called to retrieve content data in an input stream.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).
DocumentSet collection object that contains all of the publication documents to which
this document is the owner document.
SourceDocument property.
DocumentLifecyclePolicy object that represents the lifecycle policy that has been applied
to this document. A document lifecycle policy defines a set of valid lifecycle states for a document, controls the
transition of those states, and specifies the actions to be taken when a document's lifecycle state changes.
ExternalIdentityList collection of the read-only ExternalIdentity objects
that represent the identities of replicas of this object in external repositories.
FolderSet collection object containing the Folder objects in which this document is filed.
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.
true) or not (false). The current version can be a major version or a minor version.
true) or not (false).
If a document version is frozen, you cannot modify its custom properties. However, you may be
able to modify the custom properties of other versions of that document, provided they have not been frozen.
Note that the modifiability of a document's system properties is not affected by a document version's frozen status.
true) or not (false).
As long as a document is in an exception state, its lifecycle state can neither be promoted nor demoted.
To clear a document from an exception state, you must call its changeState method and set the
LifecycleChangeFlags parameter to CLEAR_EXCEPTION.
Document object, specifies whether a user has reserved the right to check in the next version following
this version (true) or not (false). For a VersionSeries object, specifies whether the
current version in this version series is checked out (true) or not (false).
true) or not (false).
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 Document objects, you can set the MimeType property for a specific document
version while it is a reservation object (at creation time and on subsequent check-outs). However,
every time you check in a document, its MimeType property value reverts to its system-assigned
value unless you explicitly set it again.
For Annotation and CmThumbnail objects, you can set this property at any time.
For DocumentClassificationAction objects, the MimeType property specifies
the type of content that a document must hold in order to allow it to be auto-classified; you can
set this property at any time.
Each content element that is attached to a document or annotation has its own MIME type,
which is specified by its ContentType property. If you do not specify the MimeType property
for a document or annotation, it is automatically set by the Content Platform Engine to the value of the
first content element, regardless of whether it is a ContentTransfer or ContentReference object.
Although the Content Platform Engine does not enforce the format of this property's value, a MIME format string consists of a content type, a content subtype, and an optional parameter in the following format: "content type/subtype[;parameter]", for example: "text/html".
MIME defines the following content types:
The following MIME types are specific to FileNet:
ContentReference content element.ContentReference content elements only.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.
Document object representing the
owner document associated with the published document. If this document is a publication and there
is a cascade delete relationship with the source, then this property will specify the publication
source document (the OwnerDocument and PublicationSource properties
will reference the same document).
DocumentSet collection object that contains the parent Document objects
bound to this child document. The collection contains only those parent documents for which the user has read
access. For each ComponentRelationship object that references this document as the
child component document, the collection contains the parent component document. The same parent document
can be in the collection more than once.
ComponentRelationshipSet collection object that contains the ComponentRelationship
objects referencing this document as the child component document. The collection contains only those
parent relationship objects for which the user has read access.
<publicationinfo>
<styletemplateid>{14917CF3-4D5F-499D-BA38-8E010199745E}</styletemplateid> <publishtemplateid>{4D696690-EEBB-4341-9FE7-A8F715BAE96D}</publishtemplateid> <pubtemplversionseriesid>{459A0D5A-5B44-4AD1-B15C-91D7B773B3DD}</pubtemplverseriesid> <outputfolderid>{4EF26F2E-61D8-47FD-8201-EE81C3AA75FA}</outputfolderid> </publicationinfo>
If the document is not a publication, the property is empty.
RELEASED.
Note that only one document version at a time in a given version series can be in the released state.
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.
RESERVATION. A reservation object is created by the server when you check out a document,
which you can modify and check in as a new version of that document.
ReservationType constant that specifies the type of this document reservation
(collaborative or exclusive) or whether its reservation type is the same as the default object store setting.
The ReservationType property can have one of the values in the following table.
| Name | Value | Description |
|---|---|---|
COLLABORATIVE |
16 | Specifies a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete. |
EXCLUSIVE |
32 | Specifies an exclusive reservation. For this type of reservation, only the user who checked out the document can check it in. This user and a user with Full Control access can delete the reservation. |
OBJECT_STORE_DEFAULT |
0 | Specifies that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property. |
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.
When a document is created, the order of precedence for setting the storage on the Document
instance is (from highest to lowest):
The default ClassDefinition for a document sets the StorageArea to Database Storage Area and the
StoragePolicy to All Storage Areas. Therefore, if you create a new Document instance
of the default Document ClassDefinition with only the StoragePolicy property set, the
document will use the class default for the StorageArea property (Database Storage Area).
To avoid this situation, you must set the instance value for the document's StorageArea property
to null. Because the instance value for StorageArea is set, but has no value, the
StoragePolicy property will be evaluated and used.
In general, storage policies should be used to allow administrators to properly administer their storage systems. They can assign multiple storage areas to be load balanced, and also assign standby storage areas to be used if any of the current storage areas become full.
VersionSeries object that contains all of the document versions associated with this
document or DynamicReferentialContainmentRelationship object.
VersionStatus constant that indicates the current version status of this document version.
The VersionStatus property can have one of the values in the following table.
| Name | Value | Description |
|---|---|---|
IN_PROCESS |
2 | Indicates an in-process document version. An in-process version is a version that
has been checked in and is the latest minor version. Note that only one version at a time in a given
version series can be in the IN_PROCESS state. When a reservation version is checked in as a minor
version and becomes the new in-process version, the previous in-process version becomes a superseded version. |
RELEASED |
1 | Indicates a released document version. A released version is a version that has been
checked in and is the latest major version. Note that only one version at a time in a given version series can be in
the RELEASED state. |
RESERVATION |
3 | Indicates a reservation document version. A reservation version is a version that has been checked out. |
SUPERSEDED |
4 | Indicates a superseded document version. A superseded version is a major or minor version that has been replaced by a later version. |
VersionableSet object that contains all of the document versions associated with
this document or version series.