Enterprise Information Portal APIs

com.ibm.mm.beans.workflow.event
Class CMBWorkFlowDataRequestEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.mm.beans.CMBEventBase
              |
              +--com.ibm.mm.beans.workflow.event.CMBWorkFlowDataRequestEvent
All Implemented Interfaces:
CMBBaseConstant, java.io.Serializable

public class CMBWorkFlowDataRequestEvent
extends CMBEventBase

The purpose of this event is to allow a user to perform workflow data functions.

See Also:
com.ibm.mm.beans.CMBWorkFlowDataRequestListener, com.ibm.mm.beans.CMBWorkFlowDataManagement, Serialized Form

Field 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
 
Fields inherited from interface com.ibm.mm.beans.CMBBaseConstant
ANNOTATION_MIME_TYPE, CMB_CLASS_ICM_DOC_MODEL, CMB_CLASS_ICM_DOC_PART, CMB_CLASS_ITEM, CMB_CLASS_RESOURCE_ITEM, CMB_CLASS_UNDEFINED, CMB_CONNTYPE_DYNAMIC, CMB_CONNTYPE_LOCAL, CMB_CONNTYPE_REMOTE, CMB_CONTENT_ATTRONLY, CMB_CONTENT_CHILDREN, CMB_CONTENT_ITEMTREE, CMB_CONTENT_LINKS_INBOUND, CMB_CONTENT_LINKS_OUTBOUND, CMB_CONTENT_YES, CMB_DATATYPE_COLLECTION, CMB_DATATYPE_COLLECTION_DDO, CMB_DATATYPE_COLLECTION_XDO, CMB_DATATYPE_DATAOBJECTBASE, CMB_DATATYPE_DATE, CMB_DATATYPE_DECIMAL, CMB_DATATYPE_DOUBLE, CMB_DATATYPE_FLOAT, CMB_DATATYPE_FSTRING, CMB_DATATYPE_ITEM, CMB_DATATYPE_ITEM_COLLECTION, CMB_DATATYPE_LONG, CMB_DATATYPE_OBJECT, CMB_DATATYPE_OBJECT_COLLECTION, CMB_DATATYPE_SHORT, CMB_DATATYPE_TIME, CMB_DATATYPE_TIMESTAMP, CMB_DATATYPE_UNDEFINED, CMB_DATATYPE_VSTRING, CMB_DSTYPE_CM, CMB_DSTYPE_DB2, CMB_DSTYPE_DES, CMB_DSTYPE_DJ, CMB_DSTYPE_DL, CMB_DSTYPE_DOMDOC, CMB_DSTYPE_FED, CMB_DSTYPE_FN, CMB_DSTYPE_IC, CMB_DSTYPE_ICM, CMB_DSTYPE_IP390, CMB_DSTYPE_JDBC, CMB_DSTYPE_OD, CMB_DSTYPE_VI400, CMB_EIP_LOGOUT, CMB_OBJTYPE_CMBITEM, CMB_OBJTYPE_CMBOBJECT, CMB_OP_AND, CMB_OP_BETWEEN, CMB_OP_CONTAINS_TEXT, CMB_OP_CONTAINS_TEXT_IN_CONTENT, CMB_OP_EQUAL, CMB_OP_GREATER, CMB_OP_GREATER_EQUAL, CMB_OP_IN, CMB_OP_LESS, CMB_OP_LESS_EQUAL, CMB_OP_LIKE, CMB_OP_NOT, CMB_OP_NOT_BETWEEN, CMB_OP_NOT_EQUAL, CMB_OP_NOT_IN, CMB_OP_NOT_LIKE, CMB_OP_OR, CMB_OP_UNDEFINED, CMB_QS_TYPE_COMBINED, CMB_QS_TYPE_DES, CMB_QS_TYPE_FEDERATED, CMB_QS_TYPE_IMAGE, CMB_QS_TYPE_PARAMETRIC, CMB_QS_TYPE_SQL, CMB_QS_TYPE_TEMPLATE, CMB_QS_TYPE_TEXT, CMB_QS_TYPE_UNKNOWN, CMB_QS_TYPE_XPATH, CMB_ST_SKIP_ALWAYS, CMB_ST_SKIP_NEVER, CMB_ST_SKIP_WITH_PROMPT, CMB_STATUS_FAILED, CMB_STATUS_OK, CMB_STATUS_RESULT_END, CMB_STATUS_RESULT_MORE, CMB_STATUS_RESULT_NEW, CMB_TIMESTAMP_UNDEFINED, CMB_TYPE_DOCUMENT, CMB_TYPE_FOLDER, CMB_TYPE_ITEM, CMB_TYPE_UNKNOWN, CMB_USERID_UNDEFINED, CMB_VERSION_CONTROL_ALWAYS_NEW, CMB_VERSION_CONTROL_BY_APP, CMB_VERSION_CONTROL_NEVER, CMB_VERSION_KEYWORD, CMB_VERSION_LATEST, CMB_VERSION_NEW, PROP_CACHE_ENABLED, PROP_CC2MIME_URL, PROP_CONNECTION, PROP_CONNECTION_TYPE, PROP_DATA_MANAGEMENT_ENABLED, PROP_DSTYPE, PROP_LOCAL_SERVER, PROP_NAME, PROP_NEW_PASSWORD, PROP_PASSWORD, PROP_PORT_NUMBER, PROP_QUERY_CALLBACK_THRESHOLD, PROP_QUERY_MAX_RESULTS, PROP_RESULT_PAGESIZE, PROP_RMI_HOSTNAME, PROP_SCHEMA_MANAGEMENT_ENABLED, PROP_SEARCH_ASYNCH, PROP_SEARCH_MULTI_CHARS_WILDCARD, PROP_SEARCH_PARAMETRIC_WILDCARD, PROP_SEARCH_SINGLE_CHAR_WILDCARD, PROP_SEARCH_SKIP_SERVER, PROP_SEARCH_TIMEOUT, PROP_SERVER_NAME, PROP_SV_CONNECTION_TYPE, PROP_SV_PORT_NUMBER, PROP_SV_RMI_HOSTNAME, PROP_TRACE_ENABLED, PROP_USERID
 
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

CMB_WORKFLOW_REQUEST_WORKFLOW_SUSPEND

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_SUSPEND
Event type ID constant: suspend a workflow

CMB_WORKFLOW_REQUEST_WORKFLOW_RESUME

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_RESUME
Event type ID constant: resume a workflow

CMB_WORKFLOW_REQUEST_WORKFLOW_START

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_START
Event type ID constant: start a workflow

CMB_WORKFLOW_REQUEST_WORKITEM_CHECKOUT

public static final int CMB_WORKFLOW_REQUEST_WORKITEM_CHECKOUT
Event type ID constant: check out a work item

CMB_WORKFLOW_REQUEST_WORKNOTIFICATION_CANCEL

public static final int CMB_WORKFLOW_REQUEST_WORKNOTIFICATION_CANCEL
Event type ID constant: cancel a work notification

CMB_WORKFLOW_REQUEST_WORKITEM_CHECKIN

public static final int CMB_WORKFLOW_REQUEST_WORKITEM_CHECKIN
Event type ID constant: check in a work item

CMB_WORKFLOW_REQUEST_WORKFLOW_CREATE_PROCESS_INSTANCE

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_CREATE_PROCESS_INSTANCE
Event type ID constant: create process instance

CMB_WORKFLOW_REQUEST_WORKITEM_TRANSFER

public static final int CMB_WORKFLOW_REQUEST_WORKITEM_TRANSFER
Event type ID constant: transfer a work item

CMB_WORKFLOW_REQUEST_WORKFLOW_TERMINATE

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_TERMINATE
Event type ID constant: terminate a workflow
Constructor Detail

CMBWorkFlowDataRequestEvent

public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                   int eventId,
                                   java.lang.String workFlowName)
Constructs a CMBWorkFlowDataRequestEvent. For this constructor the workFlowName is provided. This constructor is required for the event types:
Parameters:
source - the source of the event
eventId - the eventId of the event type
workFlowName - the workflow name

CMBWorkFlowDataRequestEvent

public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                   int eventId,
                                   java.lang.String workFlowName,
                                   boolean resumeDeep)
Constructs a CMBWorkFlowDataRequestEvent. For this constructor the workFlowName and resume deep is provided. This constructor is required for the event types:
Parameters:
source - the source of the event
eventId - the eventId of the event type
workFlowName - the workflow name
resumeDeep - if set to true, processing of all subprocesses are also resumed.

CMBWorkFlowDataRequestEvent

public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                   int eventId,
                                   java.lang.String workFlowName,
                                   java.lang.String suspendTime,
                                   boolean suspendDeep)
Constructs a CMBWorkFlowDataRequestEvent. The id and a String object is provided for this constructor.
This constructor is required for the event types:

If the event type is CMB_WORKFLOW_REQUEST_WORKFLOW_SUSPEND:
Parameters:
source - the event source
eventId - the event type id
workFlowName - the workflow name
suspendTime - a String, the suspend time
The suspend time is a string.
The date and time must be in military time in the format: yyyy-mo-dd-hh.mi.ss. The item will be suspended until the date/time.
A NULL suspendTime means to suspend the item indefinitely.
suspendDeep - if set to true, processing of all subprocesses are also suspended.

CMBWorkFlowDataRequestEvent

public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                   int eventId,
                                   java.lang.String workFlowName,
                                   CMBWorkFlowContainer container)
Constructs a CMBWorkFlowDataRequestEvent.
This constructore is required for the event type
  • CMB_WORKFLOW_REQUEST_WORKFLOW_START
    Parameters:
    source - the event source
    eventId - the event type id
    workFlowName - the workflow name
    container - the container used to start the workflow. If container is null then default container is used.

  • CMBWorkFlowDataRequestEvent

    public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                       int eventId,
                                       java.lang.String itemID,
                                       java.lang.String notificationName,
                                       java.lang.String notificationOwner,
                                       int notificationType)
    Constructs a CMBWorkFlowDataRequestEvent. This constructor is required for the event types:

    CMBWorkFlowDataRequestEvent

    public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                       int eventId,
                                       java.lang.String workFlowName,
                                       java.lang.String nodeName,
                                       java.lang.String owner,
                                       CMBWorkFlowContainer container)
    Constructs a CMBWorkFlowDataRequestEvent. This constructor is required for the event types:
    Parameters:
    source - the event source
    eventId - the event type id
    workFlowName - the workflow name
    nodeName - the name of the node
    owner - the owner of the work item
    container - the workitem container

    CMBWorkFlowDataRequestEvent

    public CMBWorkFlowDataRequestEvent(java.lang.Object source,
                                       int eventId,
                                       java.lang.String workFlowName,
                                       java.lang.String value1,
                                       java.lang.String value2)
    Constructs a CMBWorkFlowDataRequestEvent. This constructor is required for the event types:
    If the event type is CMB_WORKFLOW_REQUEST_GET_WORKITEM_STATE or CMB_WORKFLOW_REQUEST_WORKITEM_CHECKOUT then:
    Parameters:
    source - the event source
    eventId - the event type id
    workFlowName - the workflow name
    value1 - the name of the node
    value2 - the owner of the work item
    If the event type is CMB_WORKFLOW_REQUEST_WORKFLOW_CREATE_PROCESS_INSTANCE then:
    source - the event source
    eventId - the event type id
    workFlowName - the workflow name
    value1 - the workflow template name
    value2 - the description for the workflow

    CMBWorkFlowDataRequestEvent

    public 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. This constructor is required for the event types:
    Parameters:
    source - the event source
    eventId - the event type id
    workFlowName - the workflow name
    nodeName - the node name of the work item
    owner - the owner of the work item
    userId - the userId of the person the work item is being transfered to.
    Method Detail

    getContainer

    public CMBWorkFlowContainer getContainer()
    Gets the container. A NULL object is returned if the container attribute has not been set.

    getNodeName

    public java.lang.String getNodeName()
    Gets the node name. A NULL object is returned if the node name attribute has not been set.

    getName

    public java.lang.String getName()
    Gets the name. A NULL object is returned if the name attribute has not been set.

    getDescription

    public java.lang.String getDescription()
    Gets the description . A NULL object is returned if the description attribute has not been set.

    getPriority

    public int getPriority()
    Gets the priority . A -1 value is returned if the priority attribute has not been set.

    getWorkFlowTemplateName

    public java.lang.String getWorkFlowTemplateName()
    Gets the workflow template name. A NULL object is returned if the attribute has not been set.

    getUserID

    public java.lang.String getUserID()
    Gets the user id. A NULL object is returned if the attribute has not been set.

    getOwner

    public java.lang.String getOwner()
    Gets the owner property. A NULL object is returned if the attribute has not been set.

    getSuspendTime

    public java.lang.String getSuspendTime()
    Gets the suspend time of the workPacket. A NULL object is returned if the _suspendTime attribute has not been set.

    getItemID

    public java.lang.String getItemID()
    Gets the unique itemID. A NULL object is returned if the itemID has not been set.

    getPersistentID

    public java.lang.String getPersistentID()
    Gets the unique persistentID. A NULL object is returned if the persistentID has not been set.

    getWorkFlowName

    public java.lang.String getWorkFlowName()
    Gets the workflow name. A NULL object is returned if the workflow name has not been set.

    getCurrentWorkFlowName

    public java.lang.String getCurrentWorkFlowName()
    Gets the current workflow name. A NULL object is returned if the current workflow name has not been set.

    getNewWorkFlowName

    public java.lang.String getNewWorkFlowName()
    Gets the new workflow name. A NULL object is returned if the new workflow name has not been set.

    getNotificationName

    public java.lang.String getNotificationName()
    Gets the notification name. A NULL object is returned if the notification name attribute has not been set.

    getNotificationOwner

    public java.lang.String getNotificationOwner()
    Gets the notification owner. A NULL object is returned if the notification owner attribute has not been set.

    getNotificationType

    public int getNotificationType()
    Gets the notification type. A -1 is returned if the notification type attribute has not been set.

    isSuspendDeep

    public boolean isSuspendDeep()
    Returns true if suspend should be suspended deep.
    Returns:
    true if the suspend should be suspended deep, false otherwise

    isResumeDeep

    public boolean isResumeDeep()
    Returns true if resume should be resumed deep.
    Returns:
    true if the resume should be resumed deep, false otherwise

    EIP JavaBeans

    (c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.