|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.GenericService atg.nucleus.TimedOperationService atg.nucleus.servlet.ServletService atg.nucleus.servlet.HttpServletService atg.servlet.DynamoServlet atg.workflow.servlet.WorkflowTaskQueryDroplet
public class WorkflowTaskQueryDroplet
A droplet used to perform workflow task queries.
This droplet performs a task query, sets the output tasks parameter to the resulting Collection of TaskInfo 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 TaskInfo objects.
Here is the complete description of the parameters to the WorkflowTaskQueryDroplet:
The following properties of WorkflowTaskQueryDroplet should be set in the properties file for this component:
TaskInfo
,
TaskAccessRights
,
DirectoryPrincipal
,
Comparator
,
ForEach
,
Range
Field Summary | |
---|---|
static ParameterName |
ACCESS_RIGHT
|
static ParameterName |
ACCESSIBLE_ONLY
|
static ParameterName |
ACTIVE_ONLY
|
static java.lang.String |
CLASS_VERSION
Class version string |
static ParameterName |
EMPTY
|
static ParameterName |
ERROR
|
static java.lang.String |
ERROR_MESSAGE
|
static ParameterName |
OUTPUT
|
static ParameterName |
OWNERSHIP
|
static ParameterName |
PRINCIPAL
|
static ParameterName |
PROCESS_NAME
|
static ParameterName |
SEGMENT_NAME
|
static ParameterName |
SORTER
|
static ParameterName |
SUBJECT_ID
|
static ParameterName |
TASK_ELEMENT_ID
|
static ParameterName |
TASK_ELEMENT_IDS
|
static ParameterName |
TASK_NAME
|
static ParameterName |
TASK_NAMES
|
static java.lang.String |
TASKS
|
Fields inherited from class atg.servlet.DynamoServlet |
---|
mAllowCleanupRequest, mParameters |
Fields inherited from class atg.nucleus.servlet.ServletService |
---|
SERVLET_INFO_KEY |
Fields inherited from class atg.nucleus.GenericService |
---|
SERVICE_INFO_KEY |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
WorkflowTaskQueryDroplet()
|
Method Summary | |
---|---|
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 |
getTasks(DynamoHttpServletRequest pRequest)
Performs the task query, and returns a Collection of TaskInfo objects which satisfy the given criteria. |
UserDirectoryUserAuthority |
getUserDirectoryUserAuthority()
Returns the UserDirectoryUserAuthority which will be used to resolve directory principals. |
WorkflowManager |
getWorkflowManager()
Returns the WorkflowManager which will be used to find tasks. |
java.lang.String |
getWorkflowViewPath()
Returns the Nucleus path of the WorkflowView which will be used to find tasks accessible to the current user. |
void |
service(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called when a request needs to be processed. |
void |
setUserDirectoryUserAuthority(UserDirectoryUserAuthority pUserAuthority)
Sets the UserDirectoryUserAuthority which will be used to resolve directory principals. |
void |
setWorkflowManager(WorkflowManager pWorkflowManager)
Sets the WorkflowManager which will be used to find tasks. |
void |
setWorkflowViewPath(java.lang.String pWorkflowViewPath)
Sets the Nucleus path of the WorkflowView which will be used to find tasks accessible to the current user. |
Methods inherited from class atg.servlet.DynamoServlet |
---|
doDelete, doGet, doPost, doPut, getParameter, getParameters, getServletContext, service, service, setParameter |
Methods inherited from class atg.nucleus.servlet.ServletService |
---|
destroy, getServletConfig, getServletInfo, init, setServletInfo |
Methods inherited from class atg.nucleus.TimedOperationService |
---|
getAverageRequestHandlingTime, getHandledRequestCount, getRequestStartTime, getTotalRequestHandlingTime, isKeepingStatistics, notifyHandledRequest, resetStatistics, setKeepingStatistics |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
public static final ParameterName ACTIVE_ONLY
public static final ParameterName ACCESSIBLE_ONLY
public static final ParameterName PRINCIPAL
public static final ParameterName ACCESS_RIGHT
public static final ParameterName OWNERSHIP
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 SORTER
public static final ParameterName OUTPUT
public static final ParameterName EMPTY
public static final ParameterName ERROR
public static final java.lang.String TASKS
public static final java.lang.String ERROR_MESSAGE
Constructor Detail |
---|
public WorkflowTaskQueryDroplet()
Method Detail |
---|
public WorkflowManager getWorkflowManager()
public void setWorkflowManager(WorkflowManager pWorkflowManager)
public java.lang.String getWorkflowViewPath()
public void setWorkflowViewPath(java.lang.String pWorkflowViewPath)
public UserDirectoryUserAuthority getUserDirectoryUserAuthority()
public void setUserDirectoryUserAuthority(UserDirectoryUserAuthority pUserAuthority)
protected java.util.Collection getTasks(DynamoHttpServletRequest pRequest) throws javax.servlet.ServletException, WorkflowException
javax.servlet.ServletException
- if missing or invalid parameters were
encountered
WorkflowException
- if there was a problem performing
the task queryTaskInfo
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 request
javax.servlet.ServletException
- if an application specific error
occurred processing this request
java.io.IOException
- if an error occurred reading data from the
request or writing data to the response
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |