The ICmThumbnail type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAuditedEvents
An EventSet collection of the Event objects containing the audited events that have occurred for the object.
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCmIsMarkedForDeletion
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.
Public propertyCreator
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.

Public propertyDateCreated
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.

Public propertyDateLastModified
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).

Public propertyElementSequenceNumber
A unique sequence number for a content element in a particular document or annotation version. Server-generated, the number serves as an unchanging identity for the content element. For annotations, on which you can change content, the element sequence number for a content element will not change. For example, if you were to change a content element's relative position within the list of content elements, the element's sequence number would be retained. Or if you were to replace the first content element with updated content, the content element would receive a new element sequence number. Element sequence numbers are not reused.

This property can be accessed from a IContentElement-based object, or from IGetContentEvent, representing the event fired when the content element specified in this property is retrieved.

Public propertyExternalReplicaIdentities
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.)
Public propertyId
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:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.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.

Public propertyImage
The thumbnail image corresponding to this object.
Public propertyImageByteCount
The length in bytes of the thumbnail image.
Public propertyInputDocument
Specifies the input document to use for this publish or thumbnail request.
Public propertyIsSystemGenerated
For a property description, indicates whether the property described has its value set automatically by the Content Engine server (true) or not (false). In general if IsSystemGenerated is true, the described property either provides system information (for example, DateCreated) or has its value determined by the server according to the results of a method call or some other operation (for example, if you call a folder's CreateSubFolder method, the system will automatically add the newly created folder to the collection of objects returned by the SubFolders property).

For ICmThumbnail, indicates whether the thumbnail image was automatically generated by the system. If the image was user generated, that is, generated by a third-party application rather than by the Content Engine, the system cannot overwrite the image with a different one. However, a client application can retrieve a ICmThumbnail object and overwrite the existing image, whether or not the image was system- or user-generated.

Public propertyLastModifier
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).

Public propertyMimeType
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:

  • text: Represent textual information in a number of character sets. A charset parameter may be used (for example, "text/plain;charset=us-ascii"). Some subtypes: plain, html, richtext.
  • image: Represents still images. Some subtypes: jpeg, gif.
  • audio: Represents audio or voice data. Some subtypes: wav, au.
  • video: Represents video data or moving-image data. Some subtypes: mpeg, mp4.
  • message: Encapsulates an entire formatted message. Some subtypes: rfc822, partial, external-body.
  • multipart: Combines several body parts of potentially different types and subtypes. Some subtypes: mixed, alternative, parallel, digest.
  • application: Represents application data (such as executables) or binary data.

The following MIME types are specific to FileNet:

  • application/x-filenet-declarerecordtemplate: Record template.
  • application/x-filenet-documentassembly: Document assembly.
  • application/x-filenet-external: An object that contains a single ContentReference content element.
  • application/x-filenet-external-is: External Image Services document.
  • application/x-filenet-publishtemplate: Publish template.
  • application/x-filenet-scenariodefinition: Scenario definition document.
  • application/x-filenet-search: Stored search.
  • application/x-filenet-searchtemplate: Search template.
  • application/x-filenet-workflowdefinition: Workflow definition document.
  • multipart/x-filenet-external: An object that contains multiple ContentReference content elements only.
Public propertyName
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.

Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyReplicationGroup
A ReplicationGroup object representing the replication group to which this replicable object belongs.

For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

(Inherited from IReplicable.)

ToggleSee Also