The ICmTextExtractionSettings 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.
(Inherited from ICmContentConversionSettings.) |
![]() | AuditedEvents |
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
(Inherited from ICmContentConversionSettings.) |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | 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.
(Inherited from ICmContentConversionSettings.)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. |
![]() | CmOutputContentType |
This property is not supported.
(Inherited from ICmContentConversionSettings.)Specifies the content type of the text extract produced by the preprocessor. |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
(Inherited from ICmContentConversionSettings.)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. |
![]() | 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.
(Inherited from ICmContentConversionSettings.)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.
(Inherited from ICmContentConversionSettings.)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). |
![]() | DisplayName |
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
(Inherited from ICmContentConversionSettings.)For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality. For ICmAuditProcessingBookmark and IAuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness. |
![]() | 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 ICmContentConversionSettings.) |
![]() | ExtractedProperties |
This property is not supported.
A list of name and value pairs for properties extracted from the content during text extraction. |
![]() | ExtractionStatus |
This property is not supported.
The status of the text extraction operation. |
![]() | ExtractLocale |
This property is not supported.
The locale name for the language in which the text extract is written, if known. |
![]() | 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}.
(Inherited from ICmContentConversionSettings.)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. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
(Inherited from ICmContentConversionSettings.)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). |
![]() | Owner |
Manages the security owner assigned to the object.
(Inherited from ICmContentConversionSettings.) |
![]() | Permissions |
Manages the discretionary permissions assigned to the object.
(Inherited from ICmContentConversionSettings.) |
![]() | 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 ICmContentConversionSettings.)For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs. |