The IPublishRequest type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyApplyDefinition
Specifies an XML string that defines the class, properties, and security to apply to the target document. This property's value is not supplied by the caller when the request is created, but is instead based on the parameters specified in the publish options and publish template at the time the request is submitted (it provides a snap-shot of the relevant properties and security that is to be applied to the publication document).
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 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 propertyDequeueHost
Specifies the host name of the server responsible for dequeuing the item. Note that a retried queue item might have a different DequeueHost value for each retry, depending on which server actually processed the queue item.
Public propertyErrorCode
Specifies an error code for a publish request that is in an error state.
Public propertyErrorDescription
Specifies an error description for a publish request that is in an error state.
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 propertyInitiatingUser
The distinguished name of the user that initiated the event, unless the event is triggered by a server background task. In that case, the property identifies the task using the following format:

[<task name>(<context>)]

where:

task name identifies the function of the background task by name, such as replication, CFS import, or the specific type of sweep policy, sweep job, or queue sweep.

context provides contextual information applicable to the task type, such as the target source repository or target class processed by the task. If the value exceeds the maximum length of the property, the context portion of the string is truncated.

Public propertyInputDocument
Specifies the input document to use for this publish or thumbnail request.
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 propertyNextRetryDate
Specifies the date and time that a retry will be attempted to process a queue item (pending action) on a target object. The value of this property is set by the server to indicate the time at which the server can retry the queued item. For newly added queue items or "dead" queue items (that is, those items which have no retries left), the value is null.
Public propertyOutputFolder
Specifies the folder where the publication document is to be filed.
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyPublicationDocument
Specifies the document to use if republishing an existing document and the option to version the current document is set.
Public propertyPublishingStatus
Specifies the status (complete, deleting, in error, in queue, or in work) of a publish request.
Public propertyPublishRequestType
Specifies an integer that indicates the type of publish request. This property is used internally by the Content Engine API.
Public propertyPublishStyleTemplate
Contains a reference to the PublishStyleTemplate object associated with this publish request.
Public propertyPublishTemplate
Contains a reference to the PublishTemplate object associated with this publish request. If this property is set, the PublishRequest object is for a publish operation. To perform a republish operation, the PublicationDocument property must be set and this property must be null.
Public propertyRetryCount
Specifies the number of remaining attempts to process the queue item. When the retry count reaches 0 for a queue item, the item is considered "dead" and no further retries are attempted. If you want to retry a "dead" queue item, reset the retry count from 0 to a positive number. The range of valid values is 0 to 16.
Public propertyStatusDescription
Provides a description of the publishing status for this publish request.

ToggleSee Also