|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.beans.workflow.CMBWorkFlowDataManagement
This bean provides services to retrieve workflow data. You can obtain an instance of this bean from CMBConnection.
CMBConnection
, Serialized FormConstructor Summary | |
CMBWorkFlowDataManagement()
Default constructor. |
Method Summary | |
void |
addCMBExceptionListener(CMBExceptionListener alistener)
CMBExceptionEvent registration method. |
void |
addCMBTraceListener(CMBTraceListener alistener)
CMBTraceEvent registration method. |
void |
addCMBWorkFlowDataReplyListener(CMBWorkFlowDataReplyListener alistener)
CMBWorkFlowDataReplyEvent registration method. |
void |
cancelWorkNotification(java.lang.String itemId,
java.lang.String notificationName,
java.lang.String owner,
int notificationType)
Cancels a work notification. |
void |
checkIn(java.lang.String workflowName,
java.lang.String nodeName,
java.lang.String owner,
CMBWorkFlowContainer container)
Checks in a work item. |
void |
checkOut(java.lang.String workflowName,
java.lang.String nodeName,
java.lang.String owner)
Checks out a work item. |
java.lang.String |
createProcessInstance(java.lang.String workflowName,
java.lang.String workFlowTemplateName,
java.lang.String description)
Create a process instance. |
java.util.Collection |
getCMBItem(java.util.Collection pidStrings)
Returns a Collection of CMBItems from a Collection of PidStrings. |
CMBItem |
getCMBItem(java.lang.String pidString)
Gets the CMBItem associated with this PidString. |
CMBConnection |
getConnection()
Gets the connection bean reference. |
boolean |
isSuspended(java.lang.String workflowName)
Checks if a workflow is suspended. |
boolean |
isTraceEnabled()
Property getter. |
void |
onCMBConnectionReply(CMBConnectionReplyEvent evt)
Implementation of connection reply service method: update the connection handle accordingly. |
void |
onWorkFlowDataRequest(CMBWorkFlowDataRequestEvent evt)
Implementation of Data request service method: perform the requested function. |
void |
propertyChange(java.beans.PropertyChangeEvent evt)
On property change, import the traceEnabled property value. |
void |
removeCMBExceptionListener(CMBExceptionListener alistener)
CMBExceptionEvent unregistration method. |
void |
removeCMBTraceListener(CMBTraceListener alistener)
CMBTraceEvent unregistration method. |
void |
removeCMBWorkFlowDataReplyListener(CMBWorkFlowDataReplyListener alistener)
CMBWorkFlowDataReplyEvent unregistration method. |
void |
resume(java.lang.String workflowName,
boolean resumeDeep)
Resumes a workflow. |
void |
setConnection(CMBConnection conn)
Set the reference of connection bean. |
void |
setTraceEnabled(boolean newValue)
Sets the trace property value. |
void |
start(java.lang.String workflowName,
CMBWorkFlowContainer inContainer)
Starts a process instance. |
void |
suspend(java.lang.String workflowName,
java.lang.String suspendDateTime,
boolean suspendDeep)
Suspends a workflow for the suspendDateTime . |
void |
terminate(java.lang.String workflowName)
Terminates the workflow. |
void |
transfer(java.lang.String workflowName,
java.lang.String nodeName,
java.lang.String owner,
java.lang.String userID)
Transfers the work item to another user. |
void |
transferNotification(java.lang.String itemId,
java.lang.String notificationName,
java.lang.String owner,
java.lang.String userID,
int notificationType)
Transfers the notification to another user. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public CMBWorkFlowDataManagement()
Method Detail |
public void onWorkFlowDataRequest(CMBWorkFlowDataRequestEvent evt)
onWorkFlowDataRequest
in interface CMBWorkFlowDataRequestListener
evt
- a CMBWorkFlowDataRequestEventpublic void transfer(java.lang.String workflowName, java.lang.String nodeName, java.lang.String owner, java.lang.String userID) throws CMBException
workflowName
- the workflow namenodeName
- the node name of the work itemowner
- the owner of the work itemuserID
- the userID of the person the work item is being transferred toCMBException
- public void transferNotification(java.lang.String itemId, java.lang.String notificationName, java.lang.String owner, java.lang.String userID, int notificationType) throws CMBException
itemId
- the id of the notificationnotificationName
- the node name of the notificationowner
- the owner of the notificationuserID
- the userID of the person the work item is being transferred tonotificationType
- the notification typeCMBException
- public CMBItem getCMBItem(java.lang.String pidString) throws CMBServerAccessErrorException, CMBConnectFailedException, CMBException
pidString
- the pidStringCMBConnectFailedException
- if
CMBServerAccessErrorException
- if unable to get access to the server.CMBException
- if there is an error occured in the Content Server.
Call CMBException.getErrorData() to get the original exception object.public java.util.Collection getCMBItem(java.util.Collection pidStrings) throws CMBServerAccessErrorException, CMBConnectFailedException, CMBException
pidString
- the pidStringCMBConnectFailedException
- if
CMBServerAccessErrorException
- if unable to get access to the server.CMBException
- if there is an error occured in the Content Server.
Call CMBException.getErrorData() to get the original exception object.public void suspend(java.lang.String workflowName, java.lang.String suspendDateTime, boolean suspendDeep) throws CMBException
workflowName
- the workflow name of the workflow which is being suspended.suspendDateTime
- the time and date to be suspended for.
subprocesses is also suspended.
The date and time must be in military time in the
format: yyyy-mo-dd-hh.mi.ss. Example 1957-12-21-22.23.00
A NULL suspendDateTime means to suspend the item indefinitely.
The current state of the workflow process that the item is on
must be CMBWorkFlowConstants.CMB_WPN_RUNNING.
If the current state of the workflow process is in CMBWorkFlowConstants.CMB_WPN_SUSPENDING or
CMBWorkFlowConstants.CMB_WPN_SUSPENDED the workflow process will first be resumed and then suspended
using the suspendDateTime.suspendDeep
- if suspendDeep is set to true , processing of allCMBException
- CMBWorkFlowConstants
public void resume(java.lang.String workflowName, boolean resumeDeep) throws CMBException
workflowName
- the workflow name of the workflow to be resumedresumeDeep
- if set to true, processing of all subprocesses is also resumedCMBException
- public java.lang.String createProcessInstance(java.lang.String workflowName, java.lang.String workFlowTemplateName, java.lang.String description) throws CMBException
workflowName
- the workflow name of the process.
If the workflow name is null or an empty string a name
will be generated by the system. If a workflow name is provided it must be unique or
an exception is thrown.workFlowTemplateName
- the name of the workflow template for the process instancedescription
- the description of the workflow processCMBException
- public void cancelWorkNotification(java.lang.String itemId, java.lang.String notificationName, java.lang.String owner, int notificationType) throws CMBException
itemId
- the notification unique idnotificationName
- the notification nameowner
- the owner namenotificationType
- the notification typeCMBException
- CMBWorkNotification
public void checkIn(java.lang.String workflowName, java.lang.String nodeName, java.lang.String owner, CMBWorkFlowContainer container) throws CMBException
workflowName
- the workflow name of the workflow which is to be checked innodeName
- the node name attribute of the work itemowner
- the owner attribute of the work item identifiedcontainer
- the container for the work item. If container is null the default
container is used.CMBException
- com.ibm.mm.beans.workflow.CMBWorkFlowDataManagement.checkOut(String,String,String)
,
com.ibm.mm.beans.workflow.CMBWorkFlowQueryService.getContainer(String,String,String)
,
CMBWorkFlowTemplate
,
CMBWorkFlowConstants
public void start(java.lang.String workflowName, CMBWorkFlowContainer inContainer) throws CMBException
workflowName
- the workflow name of the process instance.inContainer
- the container used to start the workflow. If inContainer is null
then default container is used.CMBException
- CMBWorkFlowTemplate
,
CMBWorkFlowQueryService.getContainer(String)
public void checkOut(java.lang.String workflowName, java.lang.String nodeName, java.lang.String owner) throws CMBException
workflowName
- the workflow name for the work itemnodeName
- the node name of the work item.owner
- the owner of the work item.CMBException
- com.ibm.mm.beans.workflow.CMBWorkFlowQueryService.getState(String,String,String)
,
CMBWorkFlowConstants
public void terminate(java.lang.String workflowName) throws CMBException
workflowName
- the name of the workflowCMBException
- public boolean isSuspended(java.lang.String workflowName) throws CMBException
workflowName
- the workflow nameCMBException
- public void onCMBConnectionReply(CMBConnectionReplyEvent evt)
onCMBConnectionReply
in interface CMBConnectionReplyListener
evt
- a CMBConnectionReplyEventpublic void propertyChange(java.beans.PropertyChangeEvent evt)
propertyChange
in interface java.beans.PropertyChangeListener
evt
- a property changed eventpublic void addCMBExceptionListener(CMBExceptionListener alistener)
alistener
- listener to be registeredpublic void removeCMBExceptionListener(CMBExceptionListener alistener)
alistener
- listener to be unregisteredpublic void addCMBTraceListener(CMBTraceListener alistener)
alistener
- listener to be registeredpublic void removeCMBTraceListener(CMBTraceListener alistener)
alistener
- listener to be unregisteredpublic void addCMBWorkFlowDataReplyListener(CMBWorkFlowDataReplyListener alistener)
alistener
- listener to be registeredpublic void removeCMBWorkFlowDataReplyListener(CMBWorkFlowDataReplyListener alistener)
alistener
- listener to be unregisteredpublic boolean isTraceEnabled()
public void setTraceEnabled(boolean newValue)
newValue
- new trace option valuepublic void setConnection(CMBConnection conn)
conn
- reference of connection beanpublic CMBConnection getConnection()
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |