|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PublishRequest
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
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 |
---|
java.lang.String get_Creator()
void set_Creator(java.lang.String value)
java.util.Date get_DateCreated()
void set_DateCreated(java.util.Date value)
java.lang.String get_LastModifier()
void set_LastModifier(java.lang.String value)
java.util.Date get_DateLastModified()
void set_DateLastModified(java.util.Date value)
Id get_Id()
PublishingStatus get_PublishingStatus()
java.lang.String get_StatusDescription()
Document get_InputDocument()
void set_InputDocument(Document value)
Folder get_OutputFolder()
java.lang.Integer get_PublishRequestType()
PublishTemplate get_PublishTemplate()
void set_PublishTemplate(PublishTemplate value)
Document get_PublicationDocument()
void set_PublicationDocument(Document value)
PublishStyleTemplate get_PublishStyleTemplate()
java.lang.String get_ApplyDefinition()
java.lang.String get_ErrorCode()
java.lang.String get_ErrorDescription()
java.lang.Integer get_RetryCount()
void set_RetryCount(java.lang.Integer value)
java.util.Date get_NextRetryDate()
java.lang.String get_DequeueHost()
java.lang.String get_InitiatingUser()
EventSet get_AuditedEvents()
void setPublishOptions(java.lang.String publishOptions)
publishOptions
XML.
publishOptions
- A string containing XML that specifies the publish options for the published document.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |