com.ibm.workflow.api
Interface WorkList

All Superinterfaces:
PersistentList

public interface WorkList
extends PersistentList


Method Summary
 boolean beepOption()
          Indicates whether a beep should sound when the contents of the worklist changes.
 ActivityInstanceNotification[] queryActivityInstanceNotifications()
          This API call retrieves the primary information for all activity instance notifications characterized by the specified worklist from the MQ Workflow execution server (action call).
 int queryActivityInstanceNotificationsResultSize()
          This API call returns the number of qualifying activity instance notification characterized by the specified worklist from the MQ Workflow execution server (action call).
 Item[] queryItems()
          This API call retrieves the primary information for all items characterized by the specified worklist from the MQ Workflow execution server (action call).
 int queryItemsResultSize()
          This API call returns the number of qualifying items characterized by the specified worklist from the MQ Workflow execution server (action call).
 ProcessInstanceNotification[] queryProcessInstanceNotifications()
          This API call retrieves the primary information for all process instance notifications characterized by the specified worklist from the MQ Workflow execution server (action call).
 int queryProcessInstanceNotificationsResultSize()
          This API call returns the number of qualifying process instance notification characterized by the specified worklist from the MQ Workflow execution server (action call).
 WorkItem[] queryWorkItems()
          This API call retrieves the primary information for all work items characterized by the specified worklist from the MQ Workflow execution server (action call).
 int queryWorkItemsResultSize()
          This API call returns the number of qualifying work items characterized by the specified worklist from the MQ Workflow execution server (action call).
 
Methods inherited from interface com.ibm.workflow.api.PersistentList
delete, description, filter, isEmpty, name, ownerOfList, persistentOid, refresh, setDescription, setFilter, setSortCriteria, setThreshold, sortCriteria, threshold, type
 

Method Detail

beepOption

public boolean beepOption()
                   throws FmcException
Indicates whether a beep should sound when the contents of the worklist changes.

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstanceNotifications

public ActivityInstanceNotification[] queryActivityInstanceNotifications()
                                                                  throws FmcException

This API call retrieves the primary information for all activity instance notifications characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying activity instance notifications, only those are retrieved, the user is authorized for. The user is authorized for an activity instance notification if

The primary information that is retrieved for each activity instance notification is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryItems

public Item[] queryItems()
                  throws FmcException

This API call retrieves the primary information for all items characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying items, only those are retrieved, the user is authorized for. The user is authorized for an item if

The primary information that is retrieved for each item is:

If the item is an actual work item or an activity instance notification, then additional primary information is retrieved:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessInstanceNotifications

public ProcessInstanceNotification[] queryProcessInstanceNotifications()
                                                                throws FmcException

This API call retrieves the primary information for all process instance notifications characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying process instance notifications, only those are retrieved, the user is authorized for. The user is authorized for a process instance notification if

The primary information that is retrieved for each process instance notification is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryWorkItems

public WorkItem[] queryWorkItems()
                          throws FmcException

This API call retrieves the primary information for all work items characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying work items, only those are retrieved, the user is authorized for. The user is authorized for a work item if

The primary information that is retrieved for each work item is:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryActivityInstanceNotificationsResultSize

public int queryActivityInstanceNotificationsResultSize()
                                                 throws FmcException

This API call returns the number of qualifying activity instance notification characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying activity instance notifications, only those are counted for which the user is authorized. The user is authorized for an activity instance notification in the following circumstances:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryItemsResultSize

public int queryItemsResultSize()
                         throws FmcException

This API call returns the number of qualifying items characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying items, only those are counted for which the user is authorized. The user is authorized for an item in the following circumstances:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryProcessInstanceNotificationsResultSize

public int queryProcessInstanceNotificationsResultSize()
                                                throws FmcException

This API call returns the number of qualifying process instance notification characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying process instance notification, only those are counted for which the user is authorized. The user is authorized for a process instance notification in the following circumstances:

Throws:
FmcException - thrown if an API error or a communication error occurred.

queryWorkItemsResultSize

public int queryWorkItemsResultSize()
                             throws FmcException

This API call returns the number of qualifying work items characterized by the specified worklist from the MQ Workflow execution server (action call).

From the set of qualifying work items, only those are counted for which the user is authorized. The user is authorized for a work item in the following circumstances:

Throws:
FmcException - thrown if an API error or a communication error occurred.


© Copyright IBM Corporation 1999, 2008. All Rights Reserved.