|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Not Implemented in CS Java Connector v3.0.
APublishRequest
object represents a queued request to publish a
document using a specified PublishTemplate
object. Publishing
transformation engines process these objects and produce published documents
as a result. The PublishRequest
interface extends the CustomObject
interface, and adds several properties
To initiate (create) a publish request, call the
publish
or
republish
method on a
Document
object. You specify
which PublishTemplate
object to use in these calls.
If a PublishTemplate
object has a StyleTemplate
object associated with
it, then the PublishRequest
object is persisted to the Content Services server.
(The StyleTemplate
object describes how a transformation engine will translate a
source document as opposed to just copying it without transformation.)
Otherwise, if the publish request operation occurs immediately (that is, no
transform is involved), the PublishRequest
object will reflect
a completed status and will not represent a persisted request. (We frequently
use the term, transient, to refer to this type of PublishRequest
object.)
PublishRequest
objects are deleted when the
transformation engine has completed the publication of the document requested.
You can also call the
createObject
method on an ObjectStore
object to create a publish request. You
must set the InputDocument, Options, and Status properties for the PublishRequest
object. You would typically not create one via the createObject
method unless your application uses non-FileNet-supplied publishing plug-ins.
You can instantiate a persisted PublishRequest
object in the following ways:
getObject
method
on an ObjectStore
object.PublishRequests
collection, then returning a
PublishRequest
object from the collection. See the
PublishRequests
interface for ways to instantiate a PublishRequests
collection.
Field Summary |
Fields inherited from interface com.filenet.wcm.api.ContainableObject |
INVALID_CONTAINMENT_NAME_CHARACTERS |
Method Summary | |
void |
delete()
Not Implemented in CS Java Connector v3.0. |
void |
retry()
Not Implemented in CS Java Connector v3.0. |
Methods inherited from interface com.filenet.wcm.api.CustomObject |
applySecurityTemplate, changeClass, getAccessMask, getHeadLinks, getHeadLinksXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, getUserAccessXML, raiseEvent |
Methods inherited from interface com.filenet.wcm.api.BaseObject |
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject |
Methods inherited from interface com.filenet.wcm.api.ContainableObject |
file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile |
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget |
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML |
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject |
setPermissions, setPermissions |
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject |
setProperties |
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject |
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh |
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject |
getPermissions, getPermissions |
Methods inherited from interface com.filenet.wcm.api.LockableObject |
extendLock, extendLock, isLocked, lock, unlock, unlock |
Method Detail |
public void delete()
Not Implemented in CS Java Connector v3.0.
Deletes thisPublishRequest
object if the user has permission to
do so and there is no other constraint upon it that makes it non-deletable
(for example, publish requests are non-deletable while they are being
processed by a transformation engine). After a successful call to delete
,
all properties are considered stale and removed from cache for this
PublishRequest
object.
delete
in interface CustomObject
public void retry()
Not Implemented in CS Java Connector v3.0.
Resets the status of thisPublishRequest
object to InQueue from InError
if the user has permission to do so. After a successful call to retry
,
this method increments the RetryNumber property for this PublishRequest
object.
Also, all properties are considered stale and removed from cache for this
PublishRequest
object.
|
FileNet Content Services Java Connector v3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |