Enterprise Information Portal APIs

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

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

public class CMBWorkListReplyEvent
extends CMBEventBase

Event for replying to requests.

See Also:
com.ibm.mm.beans.CMBWorkListReplyListener, com.ibm.mm.beans.CMBWorkListRequestEvent, Serialized Form

Field Summary
static int CMB_WORKFLOW_REPLY_ACTION
          Event type ID constant: reply to a action request
static int CMB_WORKFLOW_REPLY_ACTION_LIST
          Event type ID constant: reply to an action list request
static int CMB_WORKFLOW_REPLY_GET_WORKITEM_STATE
          Event type ID constant: reply to the request get workItem state
static int CMB_WORKFLOW_REPLY_WORKFLOW_CONTAINER
          Event type ID constant: reply to a request for a process instance container for a given work list.
static int CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATE_NAMES
          Event type ID constant: list of workFlowTemplates
static int CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATES
          Event type ID constant: list of workFlowTemplates
static int CMB_WORKFLOW_REPLY_WORKFLOWS
          Event type ID constant: list of workflows
static int CMB_WORKFLOW_REPLY_WORKFLOWS_WITH_FILTER
          Event type ID constant: reply to the request get workflows with a given filter
static int CMB_WORKFLOW_REPLY_WORKITEM
          Event type ID constant: reply to a work item request
static int CMB_WORKFLOW_REPLY_WORKITEM_CONTAINER
          Event type ID constant: reply to a request for a work item container for a given work list.
static int CMB_WORKFLOW_REPLY_WORKITEMS_FOR_WORKLIST
          Event type ID constant: reply to a request for a collection of all work Items for a given work list.
static int CMB_WORKFLOW_REPLY_WORKITEMS_WITH_FILTER
          Event type ID constant: reply to the request get work items with a given filter
static int CMB_WORKFLOW_REPLY_WORKLIST_BYNAME
          Event type ID constant: reply to request of a CMBWorkList for a given worklist name.
static int CMB_WORKFLOW_REPLY_WORKLIST_NAMES
          Event type ID constant: reply to a request for a collection of workList names
static int CMB_WORKFLOW_REPLY_WORKLISTS
          Event type ID constant: list of worklists
static int CMB_WORKFLOW_REPLY_WORKNOTIFICATIONS
          Event type ID constant: notification list
static int CMB_WORKFLOW_REPLY_WORKNOTIFICATIONS_FOR_WORKLIST
          Event type ID constant: reply to a request for a collection of work notifications for a given work list.
 
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
CMBWorkListReplyEvent(java.lang.Object source, int eventId, java.lang.Exception data)
          Reply a failed request, exception object provided.
CMBWorkListReplyEvent(java.lang.Object source, int eventId, int status)
          Construct a CMBWorkListReplyEvent, result data provided.
CMBWorkListReplyEvent(java.lang.Object source, int eventId, int status, java.lang.Object data)
          Reply a succeeded request, result data provided.
CMBWorkListReplyEvent(java.lang.Object source, int eventId, int status, java.lang.Object data, java.lang.Object extraData)
          Reply a failed request, exception object provided.
 
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_REPLY_WORKNOTIFICATIONS

public static final int CMB_WORKFLOW_REPLY_WORKNOTIFICATIONS
Event type ID constant: notification list

CMB_WORKFLOW_REPLY_WORKLISTS

public static final int CMB_WORKFLOW_REPLY_WORKLISTS
Event type ID constant: list of worklists

CMB_WORKFLOW_REPLY_WORKFLOWS

public static final int CMB_WORKFLOW_REPLY_WORKFLOWS
Event type ID constant: list of workflows

CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATES

public static final int CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATES
Event type ID constant: list of workFlowTemplates

CMB_WORKFLOW_REPLY_ACTION

public static final int CMB_WORKFLOW_REPLY_ACTION
Event type ID constant: reply to a action request

CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATE_NAMES

public static final int CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATE_NAMES
Event type ID constant: list of workFlowTemplates

CMB_WORKFLOW_REPLY_WORKLIST_BYNAME

public static final int CMB_WORKFLOW_REPLY_WORKLIST_BYNAME
Event type ID constant: reply to request of a CMBWorkList for a given worklist name.

CMB_WORKFLOW_REPLY_WORKITEM

public static final int CMB_WORKFLOW_REPLY_WORKITEM
Event type ID constant: reply to a work item request

CMB_WORKFLOW_REPLY_ACTION_LIST

public static final int CMB_WORKFLOW_REPLY_ACTION_LIST
Event type ID constant: reply to an action list request

CMB_WORKFLOW_REPLY_WORKLIST_NAMES

public static final int CMB_WORKFLOW_REPLY_WORKLIST_NAMES
Event type ID constant: reply to a request for a collection of workList names

CMB_WORKFLOW_REPLY_WORKITEMS_FOR_WORKLIST

public static final int CMB_WORKFLOW_REPLY_WORKITEMS_FOR_WORKLIST
Event type ID constant: reply to a request for a collection of all work Items for a given work list.

CMB_WORKFLOW_REPLY_WORKNOTIFICATIONS_FOR_WORKLIST

public static final int CMB_WORKFLOW_REPLY_WORKNOTIFICATIONS_FOR_WORKLIST
Event type ID constant: reply to a request for a collection of work notifications for a given work list.

CMB_WORKFLOW_REPLY_WORKFLOW_CONTAINER

public static final int CMB_WORKFLOW_REPLY_WORKFLOW_CONTAINER
Event type ID constant: reply to a request for a process instance container for a given work list.

CMB_WORKFLOW_REPLY_WORKITEM_CONTAINER

public static final int CMB_WORKFLOW_REPLY_WORKITEM_CONTAINER
Event type ID constant: reply to a request for a work item container for a given work list.

CMB_WORKFLOW_REPLY_GET_WORKITEM_STATE

public static final int CMB_WORKFLOW_REPLY_GET_WORKITEM_STATE
Event type ID constant: reply to the request get workItem state

CMB_WORKFLOW_REPLY_WORKFLOWS_WITH_FILTER

public static final int CMB_WORKFLOW_REPLY_WORKFLOWS_WITH_FILTER
Event type ID constant: reply to the request get workflows with a given filter

CMB_WORKFLOW_REPLY_WORKITEMS_WITH_FILTER

public static final int CMB_WORKFLOW_REPLY_WORKITEMS_WITH_FILTER
Event type ID constant: reply to the request get work items with a given filter
Constructor Detail

CMBWorkListReplyEvent

public CMBWorkListReplyEvent(java.lang.Object source,
                             int eventId,
                             int status)
Construct a CMBWorkListReplyEvent, result data provided.
Parameters:
source - the event source
eventId - the event type id
status - the reply status

CMBWorkListReplyEvent

public CMBWorkListReplyEvent(java.lang.Object source,
                             int eventId,
                             int status,
                             java.lang.Object data)
Reply a succeeded request, result data provided.
Parameters:
source - the event source
eventId - the event type id
status - the event status CMB_STATUS_OK or CMB_STATUS_FAILED
data - if status is CMB_STATUS_OK the data is:
  • if the event id is CMB_WORKFLOW_REPLY_ACTION_LIST the reply data is a String[], a list of the actions names for the action list.
  • if the event id is CMB_WORKFLOW_REPLY_WORKLIST_NAMES the reply data is a collection of String objects, the names of the wi.
  • if the event id is CMB_WORKFLOW_REPLY_WORKNOTIFICATION the reply data is a collection of CMBWorkNotification
  • if the event id is CMB_WORKFLOW_REPLYT_WORKITEMS_FOR_WORKLIST the reply data is a collection of CMBWorkItem objects
  • if the event id is CMB_WORKFLOW_REPLY_WORKNOTIFICATIONS_FOR_WORKLIST the reply data is a collection of CMBWorkNotification objects
  • if the event id is CMB_WORKFLOW_REPLY_WORKLISTS the reply data is a collection of CMBWorkList objects
  • if the event id is CMB_WORKFLOW_REPLY_WORKFLOWS the reply data is a collection of CMBWorkFlow objects
  • if the event id is CMB_WORKFLOW_REPLY_WORKFLOWS_WITH_FILTER the reply data is a collection of CMBWorkFlow objects
  • if the event id is CMB_WORKFLOW_REPLY_WORKITEMS_WITH_FILTER the reply data is a collection of CMBWorkItem objects
  • if the event id is CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATES the reply data is a collection of CMBWorkFlowTemplates
  • if the event id is CMB_WORKFLOW_REPLY_WORKFLOW_TEMPLATE_NAMES the reply data is a collection of String objects, the names of the work flow templates in the system
  • if the event id is CMB_WORKFLOW_REPLY_ACTION the reply data is a CMBWorkFlowAction
  • if the event id is CMB_WORKFLOW_REPLY_WORKLIST_BYNAME the reply data is a CMBWorkList object for the given name.
  • if the event id is CMB_WORKFLOW_REPLY_WORKITEM the reply data a CMBWorkItem object.
  • if the event id is CMB_WORKFLOW_REPLY_WORKFLOW_CONTAINER the reply data a CMBWorkFlowContainer object.
  • if the event id is CMB_WORKFLOW_REPLY_WORKITEM_CONTAINER the reply data a CMBWorkFlowContainer object.
  • if the event id is CMB_WORKFLOW_REPLY_GET_WORKITEM_STATE the reply data is a String representation of an int, the state of the workItem. The workItem states are defined in CMBWorkFlowConstants.

    if status is CMB_STATUS_FAILED, data is an error string.


  • CMBWorkListReplyEvent

    public CMBWorkListReplyEvent(java.lang.Object source,
                                 int eventId,
                                 java.lang.Exception data)
    Reply a failed request, exception object provided.
    Parameters:
    source - the event source
    eventId - the event type id
    data - the result data is the exception data

    CMBWorkListReplyEvent

    public CMBWorkListReplyEvent(java.lang.Object source,
                                 int eventId,
                                 int status,
                                 java.lang.Object data,
                                 java.lang.Object extraData)
    Reply a failed request, exception object provided.
    Parameters:
    source - the event source
    eventId - the event type id
    status - the event status CMB_STATUS_OK or CMB_STATUS_FAILED
    data - if status is CMB_STATUS_FAILED, the exception message
    extraData - if status is CMB_STATUS_FAILED, the exception object

    EIP JavaBeans

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