com.filenet.api.publishing
Interface PublishRequest

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable

public interface PublishRequest
extends RepositoryObject, Subscribable, IndependentlyPersistableObject

Represents a queued request to publish a document using a specified PublishTemplate object. All publish requests are processed asynchronously, including copy operations, which do not transform the document. Once a PublishRequest object is saved, it is always enqueued.

A publish request can be for a publish or republish operation, as determined by the PublishTemplate and PublicationDocument properties. If the PublishTemplate property is set and the PublicationDocument property is null, the request is for a publish operation. Otherwise, if the PublicationDocument property is set, the publish request is for a republish operation.

A PublishRequest object can be created by calling the publish or republish methods on a Document object. Alternatively, a PublishRequest can be created by calling Factory.PublishRequest.createInstance and filling in the desired properties prior to saving. In either case, when the object is saved, it goes into the publish request queue, where it will be processed asynchronously by a publishing event handler.

Once a PublishRequest object has been successfully processed, it is deleted from the server.

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: true
Name: Id
Searchable: true
StorageType: ObjectStore
SuperclassName: Subscribable


Method Summary
 java.lang.String get_ApplyDefinition()
          Returns the value of the ApplyDefinition property.
 EventSet get_AuditedEvents()
          Returns the value of the AuditedEvents property.
 java.lang.String get_Creator()
          Returns the value of the Creator property.
 java.util.Date get_DateCreated()
          Returns the value of the DateCreated property.
 java.util.Date get_DateLastModified()
          Returns the value of the DateLastModified property.
 java.lang.String get_DequeueHost()
          Returns the value of the DequeueHost property.
 java.lang.String get_ErrorCode()
          Returns the value of the ErrorCode property.
 java.lang.String get_ErrorDescription()
          Returns the value of the ErrorDescription property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.String get_InitiatingUser()
          Returns the value of the InitiatingUser property.
 Document get_InputDocument()
          Returns the value of the InputDocument property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 java.util.Date get_NextRetryDate()
          Returns the value of the NextRetryDate property.
 Folder get_OutputFolder()
          Returns the value of the OutputFolder property.
 Document get_PublicationDocument()
          Returns the value of the PublicationDocument property.
 PublishingStatus get_PublishingStatus()
          Returns the value of the PublishingStatus property.
 java.lang.Integer get_PublishRequestType()
          Returns the value of the PublishRequestType property.
 PublishStyleTemplate get_PublishStyleTemplate()
          Returns the value of the PublishStyleTemplate property.
 PublishTemplate get_PublishTemplate()
          Returns the value of the PublishTemplate property.
 java.lang.Integer get_RetryCount()
          Returns the value of the RetryCount property.
 java.lang.String get_StatusDescription()
          Returns the value of the StatusDescription property.
 void set_Creator(java.lang.String value)
          Sets the value of the Creator property.
 void set_DateCreated(java.util.Date value)
          Sets the value of the DateCreated property.
 void set_DateLastModified(java.util.Date value)
          Sets the value of the DateLastModified property.
 void set_InputDocument(Document value)
          Sets the value of the InputDocument property.
 void set_LastModifier(java.lang.String value)
          Sets the value of the LastModifier property.
 void set_PublicationDocument(Document value)
          Sets the value of the PublicationDocument property.
 void set_PublishTemplate(PublishTemplate value)
          Sets the value of the PublishTemplate property.
 void set_RetryCount(java.lang.Integer value)
          Sets the value of the RetryCount property.
 void setPublishOptions(java.lang.String publishOptions)
          Sets publish options (formatted as an XML string) that will override the publish template settings.
 
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
 
Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Creator

java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.


set_Creator

void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.


get_DateCreated

java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.


set_DateCreated

void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.


get_LastModifier

java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.


set_LastModifier

void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.


get_DateLastModified

java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.


set_DateLastModified

void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.


get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_PublishingStatus

PublishingStatus get_PublishingStatus()
Returns the value of the PublishingStatus property. For more information, see PublishingStatus Property.


get_StatusDescription

java.lang.String get_StatusDescription()
Returns the value of the StatusDescription property. For more information, see StatusDescription Property.


get_InputDocument

Document get_InputDocument()
Returns the value of the InputDocument property. For more information, see InputDocument Property.


set_InputDocument

void set_InputDocument(Document value)
Sets the value of the InputDocument property. For more information, see InputDocument Property.


get_OutputFolder

Folder get_OutputFolder()
Returns the value of the OutputFolder property. For more information, see OutputFolder Property.


get_PublishRequestType

java.lang.Integer get_PublishRequestType()
Returns the value of the PublishRequestType property. For more information, see PublishRequestType Property.


get_PublishTemplate

PublishTemplate get_PublishTemplate()
Returns the value of the PublishTemplate property. For more information, see PublishTemplate Property.


set_PublishTemplate

void set_PublishTemplate(PublishTemplate value)
Sets the value of the PublishTemplate property. For more information, see PublishTemplate Property.


get_PublicationDocument

Document get_PublicationDocument()
Returns the value of the PublicationDocument property. For more information, see PublicationDocument Property.


set_PublicationDocument

void set_PublicationDocument(Document value)
Sets the value of the PublicationDocument property. For more information, see PublicationDocument Property.


get_PublishStyleTemplate

PublishStyleTemplate get_PublishStyleTemplate()
Returns the value of the PublishStyleTemplate property. For more information, see PublishStyleTemplate Property.


get_ApplyDefinition

java.lang.String get_ApplyDefinition()
Returns the value of the ApplyDefinition property. For more information, see ApplyDefinition Property.


get_ErrorCode

java.lang.String get_ErrorCode()
Returns the value of the ErrorCode property. For more information, see ErrorCode Property.


get_ErrorDescription

java.lang.String get_ErrorDescription()
Returns the value of the ErrorDescription property. For more information, see ErrorDescription Property.


get_RetryCount

java.lang.Integer get_RetryCount()
Returns the value of the RetryCount property. For more information, see RetryCount Property.


set_RetryCount

void set_RetryCount(java.lang.Integer value)
Sets the value of the RetryCount property. For more information, see RetryCount Property.


get_NextRetryDate

java.util.Date get_NextRetryDate()
Returns the value of the NextRetryDate property. For more information, see NextRetryDate Property.


get_DequeueHost

java.lang.String get_DequeueHost()
Returns the value of the DequeueHost property. For more information, see DequeueHost Property.


get_InitiatingUser

java.lang.String get_InitiatingUser()
Returns the value of the InitiatingUser property. For more information, see InitiatingUser Property.


get_AuditedEvents

EventSet get_AuditedEvents()
Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.


setPublishOptions

void setPublishOptions(java.lang.String publishOptions)
Sets publish options (formatted as an XML string) that will override the publish template settings. See Publish Options XML for a description of the publishOptions XML.

Parameters:
publishOptions - A string containing XML that specifies the publish options for the published document.


© Copyright IBM Corporation 2006, 2009. All rights reserved.