WorklistManager is the main remote EJB interface for Worklist operations. Through the WorklistManager interface, the Worklist task operations can be performed.
Task lifecycle operations:
- create task
- abort, assign, claim, resume, return, start, stop, and suspend task
- update task information, add or remove user-defined properties
Task management operations:
- archive, delete and purge task
Task querying operations:
- get tasks based on user-defined criteria
- get task properties, request and response data
For task querying operations, using the WorklistScrollableResultsManager interface is recommended for increased scalability and performance. This allows a specified range of results to be returned from the query, instead of returning all results satisfying the querying criteria.
WorklistScrollableResultManager
Method Summary |
public void | |
public void |
|
public void |
|
public |
|
public void |
|
public void | |
public void | |
public void |
|
public |
|
public |
|
public |
|
public void |
|
public void |
|
public |
|
public int |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public |
|
public void |
|
public |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void |
|
public |
|
public |
|
public void |
|
public void |
|
public void |
|
public void |
|
public void | |
public void | |
public void |
|
Method Detail |
public void abortTask(Abort a taskString
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void archiveTasks()Archive all the tasks in their final state (COMPLETED or ABORTED) if the archiver is on.
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void assignToUser(Assign the task to the user and claim it on his behalf.String
userName,String
taskId)
throwsManagementException
,AssignmentException
,RemoteException
ManagementException
AssignmentException
RemoteException
publicAssign the task to a user (chosen by the system) in the group and claim the task on his behalf.String
assignToUserInGroup(String
groupName,String
taskId)
throwsManagementException
,AssignmentException
,RemoteException
Load for all the users in that group is calculated. The load is calculated as the number of claimed tasks by the user. The user with the least load will be selected. If there is a tie the system randomly picks a user among the tied ones.
ManagementException
AssignmentException
RemoteException
public void assignToUsersAndGroups(Assign the tasks to users and/or groupsString
[] userNamesAndOrGroupNames,String
taskId)
throwsManagementException
,AssignmentException
,RemoteException
ManagementException
AssignmentException
RemoteException
public void claimTask(Claim the task.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void claimTask(Claim the task on behalf of the user. The current user needs to be the worklist admin or the task owner.String
user,String
taskId)
throwsManagementException
,RemoteException
[@TODO- Make sure worklist admin is universally know, make it clear that the caller needs to be whatever worklist admin means. Also make sure task owner is properly defined. {Still reading the docs to make sure the definitions are well known.} ]
The task will go from the state ASSIGNED to CLAIMED.
ManagementException
RemoteException
public void completeTask(Complete a STARTED task.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicCreate a task, with all the default values.String
createTask(String
name)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicCreate a task.String
createTask(TaskCreation
taskCreation)
throwsManagementException
,RemoteException
,BusinessCalendarException
ManagementException
RemoteException
BusinessCalendarException
Related Topics
publicCreate task using an xml documentString
createTaskXML(TaskCreationXMLDocument
doc)
throwsManagementException
,BusinessCalendarException
,RemoteException
ManagementException
BusinessCalendarException
RemoteException
public void deleteTask(Delete the task.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void deleteTasks(Delete the selected tasks.TaskSelector
selector)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicReturn all the groups containing this user or groupString
[] getContainingGroups(String
userOrGroup)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public int getSelectedTasksNumber(Get the number of tasks selected.TaskSelector
selector)
throwsManagementException
,RemoteException
ManagementException
RemoteException
Related Topics
publicGet task ids of all the selected tasksString
[] getTaskIds(TaskSelector
selector)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicGet the task info object.TaskInfo
getTaskInfo(String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicGet a task info array of all the selected tasksTaskInfo
[] getTaskInfos(TaskSelector
selector)
throwsManagementException
,RemoteException
ManagementException
RemoteException
Related Topics
publicGet user defined task property values.String
[] getTaskProperties(String
[] propertyNames,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicReturn all the user defined task property names.String
[] getTaskPropertiesNames(String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicGet a user defined task property value.String
getTaskProperty(String
propertyName,String
taskId)
throwsManagementException
,RemoteException
A property is made up of a name and a value.
ManagementException
RemoteException
publicGet the task request.TaskMessage
getTaskRequest(String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicGet the task request as XmlObjectXmlObject
getTaskRequestAsXmlObject(String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicGet the task response.TaskMessage
getTaskResponse(String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicGet the task response as XmlObject.XmlObject
getTaskResponseAsXmlObject(String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicReturn all the members of a WLS groupString
[] getUsersInGroup(String
group)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void purgeTasks()Purge all the tasks that have been in their final state for more than the purge delay value. If the archiver is on and the task has not been archived yet, the task cannot be purged.
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicRemove user defined task propertiesString
[] removeTaskProperties(String
[] propertyNames,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void resumeTask(Return a task to the state it was before suspended.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void returnTask(Return a task that is in the state CLAIMED or STARTED to the state ASSIGNED with all the previous assignees.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskCanBeAborted(Specify if an assignee or the claimant can abort the task.Boolean
value,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskCanBeReassigned(Specify if a task assignee can reassign the task.Boolean
value,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskCanBeReturned(Specify if the claimant can return the task.Boolean
value,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskClaimDueBusinessDate(Set the task claim due date using a business time.BusinessTime
time,String
taskId)
throwsManagementException
,BusinessCalendarException
,RemoteException
ManagementException
BusinessCalendarException
RemoteException
public void setTaskClaimDueDate(Set the task claim due date.Date
claimDueDate,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskComment(Set a task comment.String
comment,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskCompletionDueBusinessDate(Set the task completion due date using a business time.BusinessTime
time,String
taskId)
throwsManagementException
,BusinessCalendarException
,RemoteException
ManagementException
BusinessCalendarException
RemoteException
public void setTaskCompletionDueDate(Set the task completion due date.Date
completeDueDate,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskOwner(Set the task owner. The current user must be worklist admin or task owner.String
owner,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskPriority(Set a task priority. Priority value has to be a positive integer or 0.Integer
priority,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicUpdate/Create user defined task properties.String
[] setTaskProperties(String
[] propertyNames,String
[] values,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
publicUpdate/Create a user defined task property.String
setTaskProperty(String
propertyName,String
value,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskRequest(Set the task request.TaskMessage
request,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskRequestAsXmlObject(Set the task request as XmlObject.XmlObject
request,String
mimeType,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskResponse(Set the task response.TaskMessage
response,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void setTaskResponseAsXmlObject(Set the task response as XmlObject.XmlObject
response,String
mimeType,String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void startTask(Start working on a task. The task must be in the state CLAIMED and will go to the state STARTED.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void stopTask(Returns the task from state STARTED to CLAIMED.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException
public void suspendTask(Suspend the task. No operation is allowed on the SUSPENDED task until it is resumed.String
taskId)
throwsManagementException
,RemoteException
ManagementException
RemoteException