com.ibm.itim.workflow.query
Class RequesterQueryStatement
java.lang.Object
|
+--com.ibm.itim.workflow.query.RequesterQueryStatement
- All Implemented Interfaces:
- java.io.Serializable, WorkflowQueryStatement
- public class RequesterQueryStatement
- extends java.lang.Object
- implements WorkflowQueryStatement, java.io.Serializable
Class providing process query logic based on a requester. Different
configurable parameters are available to refine the query, such as
a time frame and process type. Executing this query will search
workflow processes.
- See Also:
- Serialized Form
Field Summary |
static java.lang.String |
COMPLETED
|
static java.lang.String |
REQUESTER
|
static java.lang.String |
TYPE
|
Method Summary |
java.lang.String |
getStatement()
Returns the query logic as a workflow engine readable set of
instructions. |
void |
setActiveOnly(boolean returnActiveOnly)
Changes the filter of active only processes being returned. |
void |
setEndTime(java.util.Date end)
Changes the end time of the time frame to query on. |
void |
setProcessType(java.lang.String type)
Changes the type of process to query for. |
void |
setStartTime(java.util.Date start)
Changes the start time of the time frame to query on. |
void |
setTenantDN(DistinguishedName tenant)
Query the workflow processes on the provided tenant |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
COMPLETED
public static final java.lang.String COMPLETED
REQUESTER
public static final java.lang.String REQUESTER
TYPE
public static final java.lang.String TYPE
RequesterQueryStatement
public RequesterQueryStatement(ProcessParticipant requester)
- Constructs with a requester as its context. The default time frame
is unlimited. The default process type is all (*). Active and
inactive processes will be returned as a default behavior also.
- Parameters:
requester
- ProcessParticipant representing the requester
as the query context.
setStartTime
public void setStartTime(java.util.Date start)
- Changes the start time of the time frame to query on. No processes
created before this time will be returned.
- Parameters:
start
- Date holding the beginning of the query time frame.
Null indicates no constraint on the start time.
setEndTime
public void setEndTime(java.util.Date end)
- Changes the end time of the time frame to query on. No processes
completed after this time will be returned.
- Parameters:
end
- Date holding the beginning of the end time frame.
Null indicates no constraint on the end time.
setProcessType
public void setProcessType(java.lang.String type)
- Changes the type of process to query for. The default is all types will
be returned.
- Parameters:
type
- Type of process to query for. An empty string indicates no
type constraint.
setActiveOnly
public void setActiveOnly(boolean returnActiveOnly)
- Changes the filter of active only processes being returned. The default
is to not filter inactive processes, returning all processes. See
WorkflowProcess class for description of workflow process status
possibilities.
- Parameters:
returnActiveOnly
- True indicates inactive processes will be not
be returned. False indicates all processes will
be returned.
setTenantDN
public void setTenantDN(DistinguishedName tenant)
- Query the workflow processes on the provided tenant
- Parameters:
tenant
- tenant on which to query upon
getStatement
public java.lang.String getStatement()
- Returns the query logic as a workflow engine readable set of
instructions.
- Specified by:
getStatement
in interface WorkflowQueryStatement
- Returns:
- Workflow engine readable set of instructions.