com.ibm.itim.workflow.query
Class WorkflowProcessQuery

java.lang.Object
  |
  +--com.ibm.itim.workflow.query.WorkflowProcessQuery

public class WorkflowProcessQuery

extends java.lang.Object

Class for executing a process query against the workflow engine. The query logic is defined using a WorkflowQueryStatement. The results of the query may or may not be ordered depending on the WorkflowQueryStatement.

See Also:

WorkflowQueryStatement

Constructor Summary

WorkflowProcessQuery()

Method Summary

java.util.List	execute(WorkflowQueryStatement wfqStatement) Executes the query for workflow processes.
java.util.List	execute(WorkflowQueryStatement wfqStatement, boolean returnAllFields) Executes the query for workflow processes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowProcessQuery

public WorkflowProcessQuery()

Method Detail

execute

public java.util.List execute(WorkflowQueryStatement wfqStatement)
                       throws InvalidQueryException,
                              WorkflowException

Executes the query for workflow processes.

Parameters:

wfqStatement - WorkflowQueryStatement defining the query logic to execute.

Returns:

List of WorkflowProcess value objects that satisfy the query criteria of this object. The returned List should only be read and not modified.

Throws:

InvalidQueryException - Thrown if the statement given is invalid.

WorkflowException - Thrown if unsuccessful in executing the query.

execute

public java.util.List execute(WorkflowQueryStatement wfqStatement,
                              boolean returnAllFields)
                       throws InvalidQueryException,
                              WorkflowException

Executes the query for workflow processes.

Parameters:

wfqStatement - WorkflowQueryStatement defining the query logic to execute.

returnAllFields - Boolean value specifying whether to return all fields of a process

Returns:

List of WorkflowProcess value objects that satisfy the query criteria of this object. The returned List should only be read and not modified.

Throws:

InvalidQueryException - Thrown if the statement given is invalid.

WorkflowException - Thrown if unsuccessful in executing the query.