|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.EventObject | +--com.ibm.mm.beans.CMBEventBase | +--com.ibm.mm.beans.workflow.event.CMBWorkFlowDataRequestEvent
The purpose of this event is to allow a user to perform workflow data functions.
com.ibm.mm.beans.CMBWorkFlowDataRequestListener
,
com.ibm.mm.beans.CMBWorkFlowDataManagement
, Serialized FormField Summary | |
static int |
CMB_WORKFLOW_REQUEST_WORKFLOW_CREATE_PROCESS_INSTANCE
Event type ID constant: create process instance |
static int |
CMB_WORKFLOW_REQUEST_WORKFLOW_RESUME
Event type ID constant: resume a workflow |
static int |
CMB_WORKFLOW_REQUEST_WORKFLOW_START
Event type ID constant: start a workflow |
static int |
CMB_WORKFLOW_REQUEST_WORKFLOW_SUSPEND
Event type ID constant: suspend a workflow |
static int |
CMB_WORKFLOW_REQUEST_WORKFLOW_TERMINATE
Event type ID constant: terminate a workflow |
static int |
CMB_WORKFLOW_REQUEST_WORKITEM_CHECKIN
Event type ID constant: check in a work item |
static int |
CMB_WORKFLOW_REQUEST_WORKITEM_CHECKOUT
Event type ID constant: check out a work item |
static int |
CMB_WORKFLOW_REQUEST_WORKITEM_TRANSFER
Event type ID constant: transfer a work item |
static int |
CMB_WORKFLOW_REQUEST_WORKNOTIFICATION_CANCEL
Event type ID constant: cancel a work notification |
Fields inherited from class com.ibm.mm.beans.CMBEventBase |
CMB_REPLY_NO_CONNECTION |
Fields inherited from class java.util.EventObject |
source |
Constructor Summary | |
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName,
boolean resumeDeep)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName,
CMBWorkFlowContainer container)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName,
java.lang.String suspendTime,
boolean suspendDeep)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName,
java.lang.String value1,
java.lang.String value2)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName,
java.lang.String nodeName,
java.lang.String owner,
CMBWorkFlowContainer container)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String itemID,
java.lang.String notificationName,
java.lang.String notificationOwner,
int notificationType)
Constructs a CMBWorkFlowDataRequestEvent. |
|
CMBWorkFlowDataRequestEvent(java.lang.Object source,
int eventId,
java.lang.String workFlowName,
java.lang.String nodeName,
java.lang.String owner,
java.lang.String userId)
Constructs a CMBWorkFlowDataRequestEvent. |
Method Summary | |
CMBWorkFlowContainer |
getContainer()
Gets the container. |
java.lang.String |
getCurrentWorkFlowName()
Gets the current workflow name. |
java.lang.String |
getDescription()
Gets the description . |
java.lang.String |
getItemID()
Gets the unique itemID. |
java.lang.String |
getName()
Gets the name. |
java.lang.String |
getNewWorkFlowName()
Gets the new workflow name. |
java.lang.String |
getNodeName()
Gets the node name. |
java.lang.String |
getNotificationName()
Gets the notification name. |
java.lang.String |
getNotificationOwner()
Gets the notification owner. |
int |
getNotificationType()
Gets the notification type. |
java.lang.String |
getOwner()
Gets the owner property. |
java.lang.String |
getPersistentID()
Gets the unique persistentID. |
int |
getPriority()
Gets the priority . |
java.lang.String |
getSuspendTime()
Gets the suspend time of the workPacket. |
java.lang.String |
getUserID()
Gets the user id. |
java.lang.String |
getWorkFlowName()
Gets the workflow name. |
java.lang.String |
getWorkFlowTemplateName()
Gets the workflow template name. |
boolean |
isResumeDeep()
Returns true if resume should be resumed deep. |
boolean |
isSuspendDeep()
Returns true if suspend should be suspended deep. |
Methods inherited from class com.ibm.mm.beans.CMBEventBase |
getData, getExtraData, getID, getStatus |
Methods inherited from class java.util.EventObject |
getSource, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_SUSPEND
public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_RESUME
public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_START
public static final int CMB_WORKFLOW_REQUEST_WORKITEM_CHECKOUT
public static final int CMB_WORKFLOW_REQUEST_WORKNOTIFICATION_CANCEL
public static final int CMB_WORKFLOW_REQUEST_WORKITEM_CHECKIN
public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_CREATE_PROCESS_INSTANCE
public static final int CMB_WORKFLOW_REQUEST_WORKITEM_TRANSFER
public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_TERMINATE
Constructor Detail |
public CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName)
source
- the source of the eventeventId
- the eventId of the event typeworkFlowName
- the workflow namepublic CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, boolean resumeDeep)
source
- the source of the eventeventId
- the eventId of the event typeworkFlowName
- the workflow nameresumeDeep
- if set to true, processing of all subprocesses are also resumed.public CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, java.lang.String suspendTime, boolean suspendDeep)
source
- the event sourceeventId
- the event type idworkFlowName
- the workflow namesuspendTime
- a String, the suspend time
suspendDeep
- if set to true, processing of all subprocesses are also suspended.public CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, CMBWorkFlowContainer container)
source
- the event sourceeventId
- the event type idworkFlowName
- the workflow namecontainer
- the container used to start the workflow. If container is null
then default container is used.public CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String itemID, java.lang.String notificationName, java.lang.String notificationOwner, int notificationType)
source
- the event sourceeventId
- the event type iditemID
- the work notification unique idnotificationName
- the name of the notificationnotificationOwner
- the owner of the notificationnotificationType
- the type of notificationpublic CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, java.lang.String nodeName, java.lang.String owner, CMBWorkFlowContainer container)
source
- the event sourceeventId
- the event type idworkFlowName
- the workflow namenodeName
- the name of the nodeowner
- the owner of the work itemcontainer
- the workitem containerpublic CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, java.lang.String value1, java.lang.String value2)
source
- the event sourceeventId
- the event type idworkFlowName
- the workflow namevalue1
- the name of the nodevalue2
- the owner of the work item
source
- the event sourceeventId
- the event type idworkFlowName
- the workflow namevalue1
- the workflow template namevalue2
- the description for the workflowpublic CMBWorkFlowDataRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, java.lang.String nodeName, java.lang.String owner, java.lang.String userId)
source
- the event sourceeventId
- the event type idworkFlowName
- 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 transfered to.Method Detail |
public CMBWorkFlowContainer getContainer()
public java.lang.String getNodeName()
public java.lang.String getName()
public java.lang.String getDescription()
public int getPriority()
public java.lang.String getWorkFlowTemplateName()
public java.lang.String getUserID()
public java.lang.String getOwner()
public java.lang.String getSuspendTime()
public java.lang.String getItemID()
public java.lang.String getPersistentID()
public java.lang.String getWorkFlowName()
public java.lang.String getCurrentWorkFlowName()
public java.lang.String getNewWorkFlowName()
public java.lang.String getNotificationName()
public java.lang.String getNotificationOwner()
public int getNotificationType()
public boolean isSuspendDeep()
public boolean isResumeDeep()
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |