|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorklistTaskUser
User functions relating to worklist tasks
Method Summary | |
---|---|
void |
claimTask(String taskId)
Claim the task for the caller. |
void |
claimTaskForUser(String taskId,
String user)
Claim the task on the behalf of a specific user. |
TaskData |
getTask(String taskId)
Get the TaskData object describing persistent information about the task with the given id. |
TaskData |
getTask(String taskId,
boolean includeUserProperties)
Get the TaskData object describing persistent information about the task with the given id, optionally including user properties in the returned data. |
TaskData |
getTaskAtDate(String taskId,
Date date)
Get the state of a task as it would have appeared on the given date. |
TaskEventHistory[] |
getTaskEvents(String taskId,
Date startDate,
Date endDate)
Get all events that have occurred, sorted by date, on this task from the start date to the end date (inclusive). |
TaskPlan |
getTaskPlanForTask(String taskId)
Get the TaskPlan for the given task |
TaskPlan |
getTaskPlanForTask(TaskData taskData)
Get the TaskPlan for the given task. |
Map |
getTaskProperties(String taskId)
Get all defined properties (user and system) from a task. |
Map |
getTaskProperties(String taskId,
Property[] props)
Get one or more properties from a task. |
Map |
getTaskProperties(String taskId,
String[] propNames,
boolean includeValues)
Get one or more properties from a task. |
Map |
getTaskPropertiesForStepAction(String taskId,
String stepName,
String stepActionName)
Get the properties that are required for taking the specified action from the specified step. |
PropertyInstance |
getTaskProperty(String taskId,
Property prop)
Get a property from a task. |
boolean |
isTaskHistoryProvided(TaskPlanId taskPlanID)
Is the task plan associated with a task history provider. |
void |
returnTask(String taskId)
Return a task that is in the state CLAIMED to the state ASSIGNED with all the previous assignees. |
void |
setTaskComment(String taskId,
String comment)
Set a task comment. |
void |
setTaskProperties(String taskId,
Map propMap)
Set one or more properties on a task |
void |
setTaskProperty(String taskId,
PropertyInstance prop)
Set a property on a task. |
void |
takeActionOnTask(String taskId,
String currentStepName,
String stepActionName,
Map propMap)
Take an action on the current step for the task given by the taskId. |
void |
takeActionOnTaskAndClaim(String taskId,
String currentStepName,
String stepActionName,
Map propMap,
String postActionClaimant)
Take an action on the current step for the task given by the taskId, and then claim the task in the name of the given user. |
Method Detail |
---|
TaskData getTask(String taskId) throws ManagementException, RemoteException
ManagementException
- if no task with the given ID can be found
or some other processing error occurs.
RemoteException
TaskData getTask(String taskId, boolean includeUserProperties) throws ManagementException, RemoteException
ManagementException
- if no task with the given ID can be found
or some other processing error occurs.
RemoteException
TaskPlan getTaskPlanForTask(String taskId) throws ManagementException, RemoteException
taskId
- The ID for the task for which the task plan will be
retrieved.
ManagementException
- If the task plan is not found, or any
other error occurs retrieving the task plan.
RemoteException
TaskPlan getTaskPlanForTask(TaskData taskData) throws ManagementException, RemoteException
taskData
- The task data holder for the task for which the task plan
will be retrieved.
ManagementException
- If the task plan is not found, or any
other error occurs retrieving the task plan.
RemoteException
void setTaskComment(String taskId, String comment) throws ManagementException, RemoteException
comment
- taskId
-
ManagementException
RemoteException
void setTaskProperty(String taskId, PropertyInstance prop) throws ManagementException, DataTypeException, RemoteException
ManagementException
DataTypeException
RemoteException
void setTaskProperties(String taskId, Map propMap) throws ManagementException, RemoteException
taskId
- propMap
- A map of property name (String) to PropertyInstance
where PropertyInstance holds the value for the property.
ManagementException
RemoteException
PropertyInstance getTaskProperty(String taskId, Property prop) throws ManagementException, RemoteException
ManagementException
RemoteException
Map getTaskProperties(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
getTaskProperties(String, Property[])
,
TaskPlan.getPropertyContainer()
,
NamedObjectContainer.getChildObjects()
Map getTaskProperties(String taskId, Property[] props) throws ManagementException, RemoteException
taskId
- props
-
ManagementException
RemoteException
getTaskProperties(String, String[], boolean)
,
TaskPlan.getPropertyContainer()
,
NamedObjectContainer.getChildObjects()
Map getTaskProperties(String taskId, String[] propNames, boolean includeValues) throws ManagementException, UnknownObjectException, RemoteException
taskId
- propNames
- includeValues
- If true, the returned PropertyInstance objects will
have a value (if any is available) in them. If false, the current
value of the property is not returned. This can be useful
if you know the values are large and are going to be overwritten
anyway.
ManagementException
UnknownObjectException
- If any property name doesn't match any
valid/defined user or system property.
RemoteException
Map getTaskPropertiesForStepAction(String taskId, String stepName, String stepActionName) throws ManagementException, UnknownObjectException, RemoteException
taskId
- stepName
- stepActionName
-
ManagementException
UnknownObjectException
- If the named step or step action cannot
be found within the task plan for the given task.
RemoteException
Action.getPropertyNames()
void takeActionOnTask(String taskId, String currentStepName, String stepActionName, Map propMap) throws ManagementException, UnknownObjectException, AssignmentException, RemoteException
String taskId = ...; String actionName = ...; WorklistContext context = WorklistContext.getRemoteWorklistContext(...); WorklistTaskUser user = context.getInterfaceForTaskUser(); TaskPlanRegistry registry = context.getTaskPlanRegistry(); TaskData data = user.getTask(taskId); TaskPlan taskPlan = registry.getTaskPlan(data.getTaskPlanId()); Step step = taskPlan.getStep(data.getCurrentStepName()); StepAction action = step.getStepAction(actionName);
taskId
- currentStepName
- stepActionName
- propMap
- A map of property name (String) to PropertyInstance
objects representing properties needed for the indicated action.
May be null if no properties are required. You can get this map
from a call to getTaskPropertiesForStepAction.
ManagementException
UnknownObjectException
- If the named current step or step action
cannot be found in the task plan.
AssignmentException
RemoteException
void takeActionOnTaskAndClaim(String taskId, String currentStepName, String stepActionName, Map propMap, String postActionClaimant) throws ManagementException, UnknownObjectException, AssignmentException, RemoteException
String taskId = ...; String actionName = ...; WorklistContext context = WorklistContext.getRemoteWorklistContext(...); WorklistTaskUser user = context.getInterfaceForTaskUser(); TaskPlanRegistry registry = context.getTaskPlanRegistry(); TaskData data = user.getTask(taskId); TaskPlan taskPlan = registry.getTaskPlan(data.getTaskPlanId()); Step step = taskPlan.getStep(data.getCurrentStepName()); StepAction action = step.getStepAction(actionName);
taskId
- currentStepName
- stepActionName
- propMap
- A map of property name (String) to PropertyInstance
objects representing properties needed for the indicated action.
May be null if no properties are required.postActionClaimant
- The name of the user that should be made the
claimant after this action is complete.
ManagementException
UnknownObjectException
- If the named current step or step action
cannot be found in the task plan.
AssignmentException
RemoteException
void claimTask(String taskId) throws ManagementException, RemoteException
taskId
- the taskId
ManagementException
- * @throws RemoteException
RemoteException
void claimTaskForUser(String taskId, String user) throws ManagementException, RemoteException
taskId
- user
-
ManagementException
RemoteException
void returnTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
boolean isTaskHistoryProvided(TaskPlanId taskPlanID) throws ManagementException, RemoteException
ManagementException
RemoteException
TaskEventHistory[] getTaskEvents(String taskId, Date startDate, Date endDate) throws ManagementException, RemoteException
ManagementException
RemoteException
TaskData getTaskAtDate(String taskId, Date date) throws NotSupportedException, ManagementException, RemoteException
NotSupportedException
ManagementException
RemoteException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |