public class WorkflowInstanceQueryDroplet extends DynamoServlet
This droplet performs an instance query, sets the output
instances parameter to the resulting Collection of
ProcessInstanceInfo objects, and renders its output
parameter. It is typically used in conjunction with another
droplet, such as ForEach or Range, which specifies the formatting
of each of the ProcessInstanceInfo objects. In addition, the
information contained in each ProcessInstanceInfo (namely, the
subjectId
, processName
, and
segmentName
properties) can be passed as input
parameters to WorkflowTaskQueryDroplet, in order to obtain the
tasks corresponding to the workflow instance.
Here is the complete description of the parameters to the WorkflowInstanceQueryDroplet:
The following properties of WorkflowInstanceQueryDroplet should be set in the properties file for this component:
ProcessInstanceInfo
,
ForEach
,
Range
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static ParameterName |
EMPTY |
static ParameterName |
ERROR |
static java.lang.String |
ERROR_MESSAGE |
static java.lang.String |
INSTANCES |
static ParameterName |
OUTPUT |
static ParameterName |
PROCESS_NAME |
static ParameterName |
SEGMENT_NAME |
static ParameterName |
SUBJECT_ID |
static ParameterName |
TASK_ELEMENT_ID |
static ParameterName |
TASK_ELEMENT_IDS |
static ParameterName |
TASK_NAME |
static ParameterName |
TASK_NAMES |
mAllowCleanupRequest, mParameters
SERVLET_INFO_KEY
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
WorkflowInstanceQueryDroplet() |
Modifier and Type | Method and Description |
---|---|
void |
doStartService()
Called after the service has been created, placed into the naming
hierarchy, and initialized with its configured property values.
|
protected java.util.Collection |
getProcessInstances(DynamoHttpServletRequest pRequest)
Performs the process instance query, and returns a Collection of
ProcessInstanceInfo objects which satisfy the given criteria.
|
ProcessManager |
getProcessManager()
Returns the ProcessManager which will be used to find workflow
instances.
|
WorkflowManager |
getWorkflowManager()
Returns the WorkflowManager which provides access to workflow
information.
|
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called when a request needs to be processed.
|
void |
setProcessManager(ProcessManager pProcessManager)
Sets the ProcessManager which will be used to find workflow
instances.
|
void |
setWorkflowManager(WorkflowManager pWorkflowManager)
Sets the WorkflowManager which provides access to workflow
information.
|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, init, service, service, setParameter
destroy, getServletConfig, getServletInfo, setServletInfo
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics
addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final ParameterName SUBJECT_ID
public static final ParameterName PROCESS_NAME
public static final ParameterName SEGMENT_NAME
public static final ParameterName TASK_ELEMENT_ID
public static final ParameterName TASK_ELEMENT_IDS
public static final ParameterName TASK_NAME
public static final ParameterName TASK_NAMES
public static final ParameterName OUTPUT
public static final ParameterName EMPTY
public static final ParameterName ERROR
public static final java.lang.String INSTANCES
public static final java.lang.String ERROR_MESSAGE
public ProcessManager getProcessManager()
public void setProcessManager(ProcessManager pProcessManager)
public WorkflowManager getWorkflowManager()
public void setWorkflowManager(WorkflowManager pWorkflowManager)
protected java.util.Collection getProcessInstances(DynamoHttpServletRequest pRequest) throws javax.servlet.ServletException, ProcessException
javax.servlet.ServletException
- if missing or invalid parameters were
encounteredProcessException
- if there was a problem performing the
process instance queryProcessInstanceInfo
public void doStartService() throws ServiceException
doStartService
in class GenericService
ServiceException
- if the service had a problem starting
uppublic void service(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
service
in class DynamoServlet
pRequest
- the request to be processedpResponse
- the response object for this requestjavax.servlet.ServletException
- if an application specific error
occurred processing this requestjava.io.IOException
- if an error occurred reading data from the
request or writing data to the response