Enterprise Information Portal APIs

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

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

public class CMBWorkListRequestEvent
extends CMBEventBase

Event for requesting a workflow list

See Also:
com.ibm.mm.beans.CMBWorkListRequestListener, com.ibm.mm.beans.CMBWorkFlowQueryService, Serialized Form

Field Summary
static int CMB_WORKFLOW_REQUEST_ACTION
          Event type ID constant: request a CMBWorkFlowAction
static int CMB_WORKFLOW_REQUEST_ACTION_LIST
          Event type ID constant: request an action list
static int CMB_WORKFLOW_REQUEST_GET_WORKITEM_STATE
          Event type ID constant: request workItem state
static int CMB_WORKFLOW_REQUEST_WORKFLOW_CONTAINER
          Event type ID constant: request the workflow container for a workflow process instance
static int CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATE_NAMES
          Event type ID constant: request a list of workFlow template names
static int CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATES
          Event type ID constant: request a list of workFlow templates
static int CMB_WORKFLOW_REQUEST_WORKFLOWS
          Event type ID constant: request a list of workflows
static int CMB_WORKFLOW_REQUEST_WORKFLOWS_WITH_FILTER
          Event type ID constant: request workflows for a given filter
static int CMB_WORKFLOW_REQUEST_WORKITEM
          Event type ID constant: request a workItem
static int CMB_WORKFLOW_REQUEST_WORKITEM_CONTAINER
          Event type ID constant: request the container for a work item
static int CMB_WORKFLOW_REQUEST_WORKITEMS_FOR_WORKLIST
          Event type ID constant: request a collection of work items for a given work list
static int CMB_WORKFLOW_REQUEST_WORKITEMS_WITH_FILTER
          Event type ID constant: request work items for a given filter
static int CMB_WORKFLOW_REQUEST_WORKLIST_BYNAME
          Event type ID constant: request a CMBWorkList
static int CMB_WORKFLOW_REQUEST_WORKLIST_NAMES
          Event type ID constant: request a collection of workList names
static int CMB_WORKFLOW_REQUEST_WORKLISTS
          Event type ID constant: request a list of worklists
static int CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS
          Event type ID constant: request a list of the work notifications
static int CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS_FOR_WORKLIST
          Event type ID constant: request 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
CMBWorkListRequestEvent(java.lang.Object source, int eventId)
          Construct a CMBWorkListRequestEvent.
CMBWorkListRequestEvent(java.lang.Object source, int eventId, boolean checkOutFlag)
          Construct a CMBWorkListRequestEvent.
CMBWorkListRequestEvent(java.lang.Object source, int eventId, java.lang.String aValue)
          Construct a CMBWorkListRequestEvent.
CMBWorkListRequestEvent(java.lang.Object source, int eventId, java.lang.String name, boolean checkOutFlag)
          Construct a CMBWorkListRequestEvent.
CMBWorkListRequestEvent(java.lang.Object source, int eventId, java.lang.String filter, java.lang.String sortCriteria, int threshold)
          Construct a CMBWorkListRequestEvent.
CMBWorkListRequestEvent(java.lang.Object source, int eventId, java.lang.String workFlowName, java.lang.String nodeName, java.lang.String ownerName)
          Construct a CMBWorkListRequestEvent.
 
Method Summary
 java.lang.String getActionListName()
          Gets the action list name.
 java.lang.String getActionName()
          Gets the action name.
 boolean getCheckOutFlag()
          Gets the checkOut flag.
 java.lang.String getFilter()
          Gets the filter.
 java.lang.String getNodeName()
          Gets the nodeName.
 java.lang.String getOwnerName()
          Gets the ownerName.
 java.lang.String getSortCriteria()
          Gets the sort criteria.
 int getThreshold()
          Gets the threshold.
 java.lang.String getWorkFlowName()
          Gets the workflow name .
 java.util.Collection getWorkList()
          Gets the collection of workList objects.
 java.lang.String getWorkListName()
          Gets the workList name.
 
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_WORKNOTIFICATIONS

public static final int CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS
Event type ID constant: request a list of the work notifications

CMB_WORKFLOW_REQUEST_WORKLISTS

public static final int CMB_WORKFLOW_REQUEST_WORKLISTS
Event type ID constant: request a list of worklists

CMB_WORKFLOW_REQUEST_WORKFLOWS

public static final int CMB_WORKFLOW_REQUEST_WORKFLOWS
Event type ID constant: request a list of workflows

CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATES

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATES
Event type ID constant: request a list of workFlow templates

CMB_WORKFLOW_REQUEST_ACTION

public static final int CMB_WORKFLOW_REQUEST_ACTION
Event type ID constant: request a CMBWorkFlowAction

CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATE_NAMES

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATE_NAMES
Event type ID constant: request a list of workFlow template names

CMB_WORKFLOW_REQUEST_WORKLIST_BYNAME

public static final int CMB_WORKFLOW_REQUEST_WORKLIST_BYNAME
Event type ID constant: request a CMBWorkList

CMB_WORKFLOW_REQUEST_WORKITEM

public static final int CMB_WORKFLOW_REQUEST_WORKITEM
Event type ID constant: request a workItem

CMB_WORKFLOW_REQUEST_ACTION_LIST

public static final int CMB_WORKFLOW_REQUEST_ACTION_LIST
Event type ID constant: request an action list

CMB_WORKFLOW_REQUEST_WORKLIST_NAMES

public static final int CMB_WORKFLOW_REQUEST_WORKLIST_NAMES
Event type ID constant: request a collection of workList names

CMB_WORKFLOW_REQUEST_WORKITEMS_FOR_WORKLIST

public static final int CMB_WORKFLOW_REQUEST_WORKITEMS_FOR_WORKLIST
Event type ID constant: request a collection of work items for a given work list

CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS_FOR_WORKLIST

public static final int CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS_FOR_WORKLIST
Event type ID constant: request a collection of work notifications for a given work list

CMB_WORKFLOW_REQUEST_WORKFLOW_CONTAINER

public static final int CMB_WORKFLOW_REQUEST_WORKFLOW_CONTAINER
Event type ID constant: request the workflow container for a workflow process instance

CMB_WORKFLOW_REQUEST_WORKITEM_CONTAINER

public static final int CMB_WORKFLOW_REQUEST_WORKITEM_CONTAINER
Event type ID constant: request the container for a work item

CMB_WORKFLOW_REQUEST_GET_WORKITEM_STATE

public static final int CMB_WORKFLOW_REQUEST_GET_WORKITEM_STATE
Event type ID constant: request workItem state

CMB_WORKFLOW_REQUEST_WORKFLOWS_WITH_FILTER

public static final int CMB_WORKFLOW_REQUEST_WORKFLOWS_WITH_FILTER
Event type ID constant: request workflows for a given filter

CMB_WORKFLOW_REQUEST_WORKITEMS_WITH_FILTER

public static final int CMB_WORKFLOW_REQUEST_WORKITEMS_WITH_FILTER
Event type ID constant: request work items for a given filter
Constructor Detail

CMBWorkListRequestEvent

public CMBWorkListRequestEvent(java.lang.Object source,
                               int eventId)
Construct a CMBWorkListRequestEvent.
Parameters:
source - the event source
eventId - the event type id Valid id's for this constructor:
  • CMB_WORKFLOW_REQUEST_WORKLIST_NAMES
  • CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATE_NAMES
  • CMB_WORKFLOW_REQUEST_WORKFLOW_TEMPLATES
  • CMB_WORKFLOW_REQUEST_WORKFLOWS
  • CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS

CMBWorkListRequestEvent

public CMBWorkListRequestEvent(java.lang.Object source,
                               int eventId,
                               java.lang.String aValue)
Construct a CMBWorkListRequestEvent. For this constructor a String object is provided. This constructor is required for the event types:
Parameters:
source - the source of the event
eventId - the id of the event type
aValue - if the event type is CMB_WORKFLOW_REQUEST_ACTION
aValue - the action name
If the event type is CMB_WORKFLOW_REQUEST_ACTION_LIST
aValue - the action list name
If the event type is CMB_WORKFLOW_REQUEST_WORKNOTIFICATIONS_FOR_WORKLIST
aValue - the work list name
If the event type is CMB_WORKFLOW_REQUEST_WORKFLOW_CONTAINER
aValue - the workflow name

CMBWorkListRequestEvent

public CMBWorkListRequestEvent(java.lang.Object source,
                               int eventId,
                               java.lang.String name,
                               boolean checkOutFlag)
Construct a CMBWorkListRequestEvent. This constructor is required for the event types:
Parameters:
source - the source of the event
eventId - the id of the event type
name - name of the work list
checkOutFlag - true if the workItems in the workList are to be "checked out" otherwise false.

CMBWorkListRequestEvent

public CMBWorkListRequestEvent(java.lang.Object source,
                               int eventId,
                               boolean checkOutFlag)
Construct a CMBWorkListRequestEvent. This constructor is required for the event type:
Parameters:
source - the source of the event
eventId - the id of the event type
checkOutFlag - true if the workItems in the workList are to be "checked out" ohterwise false.

CMBWorkListRequestEvent

public CMBWorkListRequestEvent(java.lang.Object source,
                               int eventId,
                               java.lang.String workFlowName,
                               java.lang.String nodeName,
                               java.lang.String ownerName)
Construct a CMBWorkListRequestEvent. This constructor is required for the event types:
Parameters:
source - the source of the event
eventId - the id of the event type
workFlowName - the workflow name
nodeName - the nodeName of the work item
ownerName - the owner of the work item

CMBWorkListRequestEvent

public CMBWorkListRequestEvent(java.lang.Object source,
                               int eventId,
                               java.lang.String filter,
                               java.lang.String sortCriteria,
                               int threshold)
Construct a CMBWorkListRequestEvent. This constructor is required for the event types:
Parameters:
source - the source of the event
eventId - the id of the event type
filter - the string defining the filter
sortCriteria - the sortCriteria
threshold - the max number of results to be returned
Method Detail

getWorkFlowName

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

getCheckOutFlag

public boolean getCheckOutFlag()
Gets the checkOut flag. True is the default.

getNodeName

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

getThreshold

public int getThreshold()
Gets the threshold. CMBWorkFlowContants.CMB_WL_MAX_RESULTS is returned if the threshold attribute has not been set.

getSortCriteria

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

getFilter

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

getOwnerName

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

getWorkListName

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

getActionName

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

getActionListName

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

getWorkList

public java.util.Collection getWorkList()
Gets the collection of workList objects. A NULL object is returned if the collection has not been set.

EIP JavaBeans

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