com.ibm.workflow.api
Interface ProcessInstanceList

All Superinterfaces:
PersistentList

public interface ProcessInstanceList
extends PersistentList


Method Summary
 ProcessInstance[] queryProcessInstances()
          This API call retrieves the primary information for all process instances characterized by the specified process instance list from the MQ Workflow execution server (action call).
 int queryProcessInstancesResultSize()
          This API call returns the number of qualifying process instances characterized by the specified process instance list 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

queryProcessInstances

public ProcessInstance[] queryProcessInstances()
                                        throws FmcException

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

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

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

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

queryProcessInstancesResultSize

public int queryProcessInstancesResultSize()
                                    throws FmcException

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

From the set of qualifying process instances, only those instances are counted for which the user is authorized. The user is authorized for a process instance if the process instance:

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


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