|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.filenet.wcm.toolkit.server.base.WcmDpContainer
com.filenet.wcm.toolkit.server.base.WcmModule
com.filenet.wcm.toolkit.server.util.workflow.WcmWorkflowUtil
Definition class for describing a workflow utility.
Field Summary |
Fields inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
locale, NAME_DELIMITER |
Constructor Summary | |
WcmWorkflowUtil()
Default constructor. |
Method Summary | |
boolean |
doLaunchWorkflow(WcmEntryTemplate entryTemplate,
java.lang.String objectStoreName,
java.lang.String objectLabel,
java.lang.String objectId,
int objectType,
java.lang.String returnUrl)
Helper method to check to see if we need to show the participant selection ui before launching the workflow specified in the entry template. |
boolean |
doProcessParticipants(WcmEntryTemplate entryTemplate,
java.lang.String objectStoreName,
java.lang.String objectLabel,
java.lang.String objectId,
int objectType,
java.lang.String returnUrl)
Helper method to check to see if we need to show the participant selection ui before launching the workflow specifide in the entry template. |
boolean |
doProcessWorkflow(WcmEntryTemplate entryTemplate,
java.lang.String returnUrl,
java.lang.String objectStoreName,
java.lang.String objectLabel,
java.lang.String objectId,
int objectType)
Helper method to check to see if the Entry Template has a workflow specified to launch. |
java.lang.String |
getParticipantsXML(int includeType)
Gathers the list of available participants and returns them in xml format. |
boolean |
isWorkflowRunning(java.lang.String workflowNumber)
Helper method to determine if a workflow is currently running. |
void |
setAuthoringDataProvider(WcmAuthoringDataProvider dp)
Set up the Authoring Data Provider. |
void |
setCreateWorkflowUrl(java.lang.String url)
Set the jsp path to the create workflow jsp file. |
void |
setEProcessDataProvider(WcmEProcessDataProvider dp)
Set up the EProcess Data Provider. |
void |
setObjectWorkflowNumber(java.lang.String objectStoreName,
java.lang.String id,
int type,
java.lang.String attachmentId)
Get the WorkflowNumber from the recently launched wotkflow and set the value on the initiatind document. |
void |
setWorkflowPromptUrl(java.lang.String url)
Set the jsp path to the workflow prompt jsp file. |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmModule |
addChild, addChild, addChild, cleanup, debugTrace, getClassProperty, getClassProperty, getClassPropertyKeys, getConfiguration, getController, getDataStore, getModuleProperty, getModuleProperty, getModuleProperty, getModuleProperty, getModulePropertyKeys, getName, getParent, getWindowProperty, getWindowProperty, initialize, persist, queryDataProvider, setClassProperty, setClassProperty, setController, setModuleProperty, setModuleProperty, setName, setParent, setPortletParent, setWindowProperty |
Methods inherited from class com.filenet.wcm.toolkit.server.base.WcmDpContainer |
addDataProvider, addDataProvider |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.filenet.wcm.toolkit.server.base.WcmModuleInterface |
addDataProvider |
Constructor Detail |
public WcmWorkflowUtil()
Method Detail |
public void setAuthoringDataProvider(WcmAuthoringDataProvider dp)
dp
- Authoring Data Providerpublic void setEProcessDataProvider(WcmEProcessDataProvider dp)
dp
- EProcess Data Providerpublic void setWorkflowPromptUrl(java.lang.String url)
url
- String hold path to jsp.public void setCreateWorkflowUrl(java.lang.String url)
url
- String hold path to jsp.public void setObjectWorkflowNumber(java.lang.String objectStoreName, java.lang.String id, int type, java.lang.String attachmentId) throws java.lang.Exception
objectStoreName
- String Object Store nameid
- String object Id of the initiating document.type
- int Workplace object typeattachmentId
- String holding attachmentId
java.lang.Exception
- upon validation errors.public boolean isWorkflowRunning(java.lang.String workflowNumber) throws java.lang.Exception
workflowNumber
- String holding the workflow number to query for.
java.lang.Exception
- upon validation errors.public boolean doProcessWorkflow(WcmEntryTemplate entryTemplate, java.lang.String returnUrl, java.lang.String objectStoreName, java.lang.String objectLabel, java.lang.String objectId, int objectType) throws java.lang.Exception
entryTemplate
- The Entry Template.returnUrl
- String hold url to return to after finished processingobjectStoreName
- The name of the object storeobjectLabel
- The object labelobjectId
- The object idobjectType
- The object type
java.lang.Exception
- upon validation errors.public boolean doProcessParticipants(WcmEntryTemplate entryTemplate, java.lang.String objectStoreName, java.lang.String objectLabel, java.lang.String objectId, int objectType, java.lang.String returnUrl) throws java.lang.Exception
entryTemplate
- The Entry Template.objectStoreName
- String holding objectstore name of item just addedobjectLabel
- String holding object name of item just addedobjectId
- String holding object id of item just addedobjectType
- int holding object type of item just addedreturnUrl
- String hold url to return to after finished processing
java.lang.Exception
- upon validation errors.public boolean doLaunchWorkflow(WcmEntryTemplate entryTemplate, java.lang.String objectStoreName, java.lang.String objectLabel, java.lang.String objectId, int objectType, java.lang.String returnUrl) throws java.lang.Exception
entryTemplate
- The Entry Template.objectStoreName
- String holding objectstore name of item just addedobjectLabel
- String holding object name of item just addedobjectId
- String holding object id of item just addedobjectType
- int holding object type of item just addedreturnUrl
- String hold url to return to after finished processing
java.lang.Exception
- upon validation errors.public java.lang.String getParticipantsXML(int includeType) throws java.lang.Exception
includeType
- int to indicate what type of items to return in the list
0 - users
1 - groups
2 - users and groups
java.lang.Exception
- upon validation errors.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |