FileNet Content Services
Java Connector v3.0

com.filenet.wcm.api
Interface PublishRequest

All Superinterfaces:
BaseObject, ContainableObject, CreatableObject, CustomObject, GettableObject, LockableObject, ReadableMetadataObject, ReadableSecurityObject, java.io.Serializable, ValueObject, WorkflowTarget, WriteableMetadataObject, WriteableSecurityObject

public interface PublishRequest
extends CustomObject, java.io.Serializable

Not Implemented in CS Java Connector v3.0.

A PublishRequest 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:


Field Summary
 
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
 
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

delete

public void delete()

Not Implemented in CS Java Connector v3.0.

Deletes this PublishRequest 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.

Specified by:
delete in interface CustomObject

retry

public void retry()

Not Implemented in CS Java Connector v3.0.

Resets the status of this PublishRequest 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