|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorklistManager
WorklistContext
,
WorklistContextFactory
Method Summary | |
---|---|
void |
abortTask(String taskId)
Deprecated. Use WorklistTaskUser.takeActionOnStep(taskId, <Started Step>, <Abort Action>, null) for tasks not based on a task plan, or WorklistTaskAdmin.abortTask for any task. |
void |
archiveTasks()
Deprecated. Archive all the tasks in their final state (COMPLETED or ABORTED) if the archiver is on. |
void |
assignToUser(String userName,
String taskId)
Deprecated. Assign the task to the user and claim it on his behalf. |
String |
assignToUserInGroup(String groupName,
String taskId)
Deprecated. Assign the task to a user (chosen by the system) in the group and claim the task on his behalf. |
void |
assignToUsersAndGroups(String[] userNamesAndOrGroupNames,
String taskId)
Deprecated. Assign the tasks to users and/or groups |
void |
claimTask(String taskId)
Deprecated. Claim the task. |
void |
claimTask(String user,
String taskId)
Deprecated. Claim the task on behalf of the user. |
void |
completeTask(String taskId)
Deprecated. Use WorklistTaskUser.takeActionOnTask(taskId, |
String |
createTask(String name)
Deprecated. Create a task, with all the default values. |
String |
createTask(TaskCreation taskCreation)
Deprecated. Create a task. |
String |
createTaskXML(TaskCreationXMLDocument doc)
Deprecated. Create task using an xml document |
void |
deleteTask(String taskId)
Deprecated. Delete the task. |
void |
deleteTasks(TaskSelector selector)
Deprecated. Delete the selected tasks. |
String[] |
getContainingGroups(String userOrGroup)
Deprecated. Return all the groups containing this user or group |
int |
getSelectedTasksNumber(TaskSelector selector)
Deprecated. Get the number of tasks selected. |
String[] |
getTaskIds(TaskSelector selector)
Deprecated. Get task ids of all the selected tasks |
TaskInfo |
getTaskInfo(String taskId)
Deprecated. Get the task info object. |
TaskInfo[] |
getTaskInfos(TaskSelector selector)
Deprecated. Get a task info array of all the selected tasks |
String[] |
getTaskProperties(String[] propertyNames,
String taskId)
Deprecated. Use WorklistTaskUser.getTaskProperties() instead. |
String[] |
getTaskPropertiesNames(String taskId)
Deprecated. Use TaskPlan.getPropertyName() instead. |
String |
getTaskProperty(String propertyName,
String taskId)
Deprecated. Get a user defined task property value. |
TaskMessage |
getTaskRequest(String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
XmlObject |
getTaskRequestAsXmlObject(String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
TaskMessage |
getTaskResponse(String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
XmlObject |
getTaskResponseAsXmlObject(String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
String[] |
getUsersInGroup(String group)
Deprecated. Return all the members of a WLS group |
void |
purgeTasks()
Deprecated. Purge all the tasks that have been in their final state for more than the purge delay value. |
String[] |
removeTaskProperties(String[] propertyNames,
String taskId)
Deprecated. Use PropertyInstance.unsetValue() instead. |
void |
resumeTask(String taskId)
Deprecated. Use WorklistTaskAdmin.resumeTask instead |
void |
returnTask(String taskId)
Deprecated. Return a task that is in the state CLAIMED to the state ASSIGNED with all the previous assignees. |
void |
setTaskCanBeAborted(Boolean value,
String taskId)
Deprecated. Specify if an assignee or the claimant can abort the task. |
void |
setTaskCanBeReassigned(Boolean value,
String taskId)
Deprecated. Specify if a task assignee can reassign the task. |
void |
setTaskCanBeReturned(Boolean value,
String taskId)
Deprecated. Specify if the claimant can return the task. |
void |
setTaskClaimDueBusinessDate(BusinessTime time,
String taskId)
Deprecated. Set the task claim due date using a business time. |
void |
setTaskClaimDueDate(Date claimDueDate,
String taskId)
Deprecated. Set the task claim due date. |
void |
setTaskComment(String comment,
String taskId)
Deprecated. Set a task comment. |
void |
setTaskCompletionDueBusinessDate(BusinessTime time,
String taskId)
Deprecated. Set the task completion due date using a business time. |
void |
setTaskCompletionDueDate(Date completeDueDate,
String taskId)
Deprecated. Set the task completion due date. |
void |
setTaskOwner(String owner,
String taskId)
Deprecated. Set the task owner. |
void |
setTaskPriority(Integer priority,
String taskId)
Deprecated. Set a task priority. |
String[] |
setTaskProperties(String[] propertyNames,
String[] values,
String taskId)
Deprecated. Use WorklistTaskUser.setTaskProperties() instead. |
String |
setTaskProperty(String propertyName,
String value,
String taskId)
Deprecated. Use WorklistTaskUser.getTaskProperty() instead. |
void |
setTaskRequest(TaskMessage request,
String taskId)
Deprecated. Use an explicit task plan when creating your task by calling WorklistTaskAdmin.createTask(String, TaskPlan, String, String) then use WorklistTaskUser.setTaskProperty() instead passing a PropertyInstance retrieved by name from the TaskPlan associated with the task. For example: WorklistContext ctx = WorklistContextFactory.getLocalContext(); WorklistTaskUser user = ctx.getInterfaceForTaskUser(); TaskPlan taskPlan = user.getTaskPlanForTask(taskId); Property prop = taskPlan.getProperty("Request"); PropertyInstance propInstance = user.getTaskProperty(taskId, prop); propInstance.setValue(... Your request value (Object, byte[], etc.) ...) user.setTaskProperty(taskId, propInstance); |
void |
setTaskRequestAsXmlObject(XmlObject request,
String mimeType,
String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
void |
setTaskResponse(TaskMessage response,
String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
void |
setTaskResponseAsXmlObject(XmlObject response,
String mimeType,
String taskId)
Deprecated. See setTaskRequest(TaskMessage request, String taskId) for more information. |
void |
startTask(String taskId)
Deprecated. Use WorklistTaskUser.takeActionOnTask(taskId, |
void |
stopTask(String taskId)
Deprecated. Use WorklistTaskUser.takeActionOnStep(taskId, |
void |
suspendTask(String taskId)
Deprecated. Use WorklistTaskAdmin.suspendTask instead |
Method Detail |
---|
String createTask(String name) throws ManagementException, RemoteException
name
-
ManagementException
- If the operation fails.
RemoteException
- If an RMI communication error occurs.String createTask(TaskCreation taskCreation) throws ManagementException, BusinessCalendarException, AssignmentException, RemoteException
taskCreation
- object containing information about the new task.
ManagementException
- If the operation fails.
RemoteException
- If an RMI communication error occurs.
BusinessCalendarException
AssignmentException
TaskCreation
String createTaskXML(TaskCreationXMLDocument doc) throws ManagementException, BusinessCalendarException, AssignmentException, RemoteException
doc
- an XML Bean containing information about the new task.
ManagementException
RemoteException
BusinessCalendarException
AssignmentException
int getSelectedTasksNumber(TaskSelector selector) throws ManagementException, RemoteException
selector
- containing selection criteria
ManagementException
RemoteException
TaskSelector
TaskInfo getTaskInfo(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
TaskInfo[] getTaskInfos(TaskSelector selector) throws ManagementException, RemoteException
selector
- containing selection criteria
ManagementException
RemoteException
TaskSelector
String[] getTaskIds(TaskSelector selector) throws ManagementException, RemoteException
selector
- containing selection criteria
ManagementException
RemoteException
void assignToUser(String userName, String taskId) throws ManagementException, AssignmentException, RemoteException
userName
- taskId
-
ManagementException
AssignmentException
RemoteException
String assignToUserInGroup(String groupName, String taskId) throws ManagementException, 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.
groupName
- taskId
-
ManagementException
AssignmentException
RemoteException
void assignToUsersAndGroups(String[] userNamesAndOrGroupNames, String taskId) throws ManagementException, AssignmentException, RemoteException
userNamesAndOrGroupNames
- taskId
-
ManagementException
AssignmentException
RemoteException
void claimTask(String taskId) throws ManagementException, RemoteException
taskId
- the taskId
ManagementException
RemoteException
void claimTask(String user, String taskId) throws ManagementException, 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.
user
- taskId
-
ManagementException
RemoteException
void returnTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
void startTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
WorklistTaskUser#takeActionOnTask(String, String, String, java.util.Map)
void stopTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
WorklistTaskUser#takeActionOnTask(String, String, String, java.util.Map)
void suspendTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
WorklistTaskAdmin.suspendTask(String taskId)
void resumeTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
WorklistTaskAdmin.resumeTask(String taskId)
void completeTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
WorklistTaskUser#takeActionOnTask(String, String, String, java.util.Map)
,
WorklistTaskAdmin.completeTask(String)
void abortTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
WorklistTaskUser#takeActionOnTask(String, String, String, java.util.Map)
,
WorklistTaskAdmin.abortTask(String)
void setTaskComment(String comment, String taskId) throws ManagementException, RemoteException
comment
- taskId
-
ManagementException
RemoteException
void setTaskPriority(Integer priority, String taskId) throws ManagementException, RemoteException
priority
- taskId
-
ManagementException
RemoteException
void setTaskCompletionDueDate(Date completeDueDate, String taskId) throws ManagementException, RemoteException
completeDueDate
- taskId
-
ManagementException
RemoteException
void setTaskClaimDueDate(Date claimDueDate, String taskId) throws ManagementException, RemoteException
claimDueDate
- taskId
-
ManagementException
RemoteException
void setTaskCompletionDueBusinessDate(BusinessTime time, String taskId) throws ManagementException, BusinessCalendarException, RemoteException
time
- taskId
-
ManagementException
RemoteException
BusinessCalendarException
void setTaskClaimDueBusinessDate(BusinessTime time, String taskId) throws ManagementException, BusinessCalendarException, RemoteException
time
- taskId
-
ManagementException
RemoteException
BusinessCalendarException
void setTaskOwner(String owner, String taskId) throws ManagementException, RemoteException
owner
- taskId
-
ManagementException
RemoteException
void setTaskCanBeReassigned(Boolean value, String taskId) throws ManagementException, RemoteException
value
- taskId
-
ManagementException
RemoteException
void setTaskCanBeReturned(Boolean value, String taskId) throws ManagementException, RemoteException
value
- taskId
-
ManagementException
RemoteException
void setTaskCanBeAborted(Boolean value, String taskId) throws ManagementException, RemoteException
value
- taskId
-
ManagementException
RemoteException
TaskMessage getTaskRequest(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
XmlObject getTaskRequestAsXmlObject(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
void setTaskRequest(TaskMessage request, String taskId) throws ManagementException, RemoteException
WorklistContext ctx = WorklistContextFactory.getLocalContext(); WorklistTaskUser user = ctx.getInterfaceForTaskUser(); TaskPlan taskPlan = user.getTaskPlanForTask(taskId); Property prop = taskPlan.getProperty("Request"); PropertyInstance propInstance = user.getTaskProperty(taskId, prop); propInstance.setValue(... Your request value (Object, byte[], etc.) ...) user.setTaskProperty(taskId, propInstance);
request
- taskId
-
ManagementException
RemoteException
WorklistTaskUser.getTaskPlanForTask(String)
,
TaskPlan.getProperty(String)
,
WorklistTaskUser.getTaskProperty(String, com.bea.wli.worklist.api.taskplan.Property)
,
WorklistTaskUser.setTaskProperty(String, PropertyInstance)
void setTaskRequestAsXmlObject(XmlObject request, String mimeType, String taskId) throws ManagementException, RemoteException
request
- mimeType
- taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
TaskMessage getTaskResponse(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
XmlObject getTaskResponseAsXmlObject(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
void setTaskResponse(TaskMessage response, String taskId) throws ManagementException, RemoteException
response
- taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
void setTaskResponseAsXmlObject(XmlObject response, String mimeType, String taskId) throws ManagementException, RemoteException
response
- mimeType
- taskId
-
ManagementException
RemoteException
setTaskRequest(TaskMessage, String)
String getTaskProperty(String propertyName, String taskId) throws ManagementException, RemoteException
A property is made up of a name and a value. Note, in release 9.0 of WebLogic Integration, task properties can have types other than String. If a property with a type other than String is accessed via this method (or any of the property methods on this interface), a ManagementException will be thrown. It is recommended that new client code use methods on WorklistTaskUser.
propertyName
- taskId
-
ManagementException
RemoteException
WorklistTaskUser.getTaskProperty(String, com.bea.wli.worklist.api.taskplan.Property)
String[] getTaskProperties(String[] propertyNames, String taskId) throws ManagementException, RemoteException
propertyNames
- taskId
-
ManagementException
RemoteException
WorklistTaskUser.getTaskProperties(String, String[], boolean)
String setTaskProperty(String propertyName, String value, String taskId) throws ManagementException, RemoteException
propertyName
- value
- taskId
-
ManagementException
RemoteException
WorklistTaskUser.setTaskProperty(String, PropertyInstance)
String[] setTaskProperties(String[] propertyNames, String[] values, String taskId) throws ManagementException, RemoteException
propertyNames
- values
- taskId
-
ManagementException
RemoteException
WorklistTaskUser#setTaskProperties(String, java.util.Map)
String[] getTaskPropertiesNames(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
TaskPlan.getPropertyNames()
String[] removeTaskProperties(String[] propertyNames, String taskId) throws ManagementException, RemoteException
propertyNames
-
ManagementException
RemoteException
DataTypeValue.unsetValue()
void archiveTasks() throws ManagementException, RemoteException
ManagementException
RemoteException
void purgeTasks() throws ManagementException, RemoteException
ManagementException
RemoteException
void deleteTask(String taskId) throws ManagementException, RemoteException
taskId
-
ManagementException
RemoteException
void deleteTasks(TaskSelector selector) throws ManagementException, RemoteException
selector
- containing selection criteria
ManagementException
RemoteException
String[] getUsersInGroup(String group) throws ManagementException, RemoteException
group
-
ManagementException
RemoteException
String[] getContainingGroups(String userOrGroup) throws ManagementException, RemoteException
userOrGroup
-
ManagementException
RemoteException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |