The IAnnotation type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ActiveMarkings |
The list of 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.
|
![]() | AnnotatedContentElement |
Identifies the document content element to which this annotation applies. This property is intended
only as a means by which an application can match an annotation with a document content element.
The server does not use it in any way other than storing the application-provided value.
The application is responsible for how it interprets AnnotatedContentElement values. It is not a required property.
Because the positional index of a given content element within a document's ContentElementList collection is subject to change, it is recommended that you populate this property with the value of the content element's ElementSequenceNumber property rather than its positional index. If you instead choose to use a positional index, it is up to your application to ensure that it accurately reflects the correct index of the content element to which the annotation applies. For example, if the AnnotatedContentElement property specifies the positional index of the third content element of a document with five content elements, and the second content element is then removed, the property will consequently reference the wrong content element. |
![]() | AnnotatedObject |
Specifies an IndependentObject object of type Document, Folder, or CustomObject to which this annotation has been applied.
|
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
|
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | CmHoldRelationships |
An enumeration of ICmHoldRelationship objects associated with this object.
(Inherited from ICmHoldable.) |
![]() | CmIndexingFailureCode |
A bitmask of 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. |
![]() | CmIsMarkedForDeletion |
Indicates whether the object is marked (flagged) for deletion. If 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 ICmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database). See Recovery Bin Concepts. |
![]() | CmRetentionDate |
The retention expiration date and time of this object. This object can be deleted only
after the expiration date and time has passed. If this property is 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:
To set the CmRetentionDate property value on an object, you must have the following permissions:
|
![]() | ContentElements |
Specifies a 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).
|
![]() | ContentElementsPresent |
Specifies a StringList object containing the MIME type of each content element
|
![]() | ContentSize |
Specifies the size in bytes of the content data associated with this document, annotation, or
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.
|
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
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. |
![]() | DateContentLastAccessed |
Specifies the date and time when the content data (represented by a 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:
|
![]() | DateCreated |
Indicates the date and time the object was created. The Content Engine server stores dates and times using
Coordinated Universal Time (UTC). For more information, see
Timestamps.
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. |
![]() | DateLastModified |
Indicates the date and time the object was last modified. The Content Engine server stores dates and times
using Coordinated Universal Time (UTC). For more information, see
Timestamps.
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). |
![]() | DescriptiveText |
User-readable text that describes an object.
The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | ExternalReplicaIdentities |
Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects
that represent the identities of replicas of this object in external repositories.
(Inherited from IReplicable.) |
![]() | Id |
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 IUser and IGroup 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, IUser.Id and IGroup.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. |
![]() | IndexationId |
The object ID (GUID) of the IBM® Content Search Services index that is used for this object.
This value is null for objects that are full-text indexed prior to the 4.0 release.
The server sets this property if 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. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
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). |
![]() | MimeType |
Specifies the Multipurpose Internet Mail Extensions (MIME) format string of the content data
carried by this document, annotation, or document classification action.
MIME is a communications protocol that allows for the transmission of data in many forms,
such as audio, binary, or video.
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 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 format: "content type/subtype[;parameter]", for example, "text/html". MIME defines the following content types:
The following MIME types are specific to FileNet:
|
![]() | Name |
The name for this object.
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. |
![]() | Owner |
Manages the security owner assigned to the object.
|
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
|
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | ReplicationGroup |
A ReplicationGroup object representing the replication group to
which this replicable object belongs.
(Inherited from IReplicable.)For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs. |
![]() | StorageArea |
Specifies the storage area for a content-carrying object.
|
![]() | StorageLocation | Obsolete.
Specifies the storage location for an object's content. This property is deprecated in FileNet P8 4.0
and is only set in upgraded object stores. It has been replaced by the StorageArea property.
|
![]() | StoragePolicy |
Specifies the document's storage policy, which identifies the set of available storage areas that are
considered equivalent based on common, user-specified criteria. Assigning a storage policy to a document
is the recommended method of selecting a storage area. The alternative is to directly assign the storage
area (specify the StorageArea property).
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. |