|
Oracle BPEL Process Manager Workflow Services API Reference 10g Release 2 (10.1.2) B25708-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
IWorklistService is the main interface for the Worklist Service associated with BPEL Workflow. It provides a programmatic means for retrieving tasks created by the business processes and relaying back the actions performed by the users to the business processes. The methods provided by the worklist service fall into the following broad categories:
A typical worklist application will use the worklist service as follows:
A sample code fragment that uses the worklist service in the above pattern in shown below.
// 1. get a handle to the worklist service WorklistService wlSvc = WorklistService.getWorklistService(); // 2. get worklist context for current user after authentication String user = "jstein"; String password = "welcome"; IWorklistContext ctx = wlSvc.authenticateUser(user, password); // 3. set filters for retrieving ?My? tasks with ?Assigned? status // sorted by task title is ascending order Map filterMap = new HashMap(); filterMap.put(IWorklistService.FILTER_TYPE_TASK_FILTER, IWorklistService.TASK_FILTER_MY); filterMap.put(IWorklistService.FILTER_TYPE_STATUS_FILTER, IWorklistService.STATUS_FILTER_ASSIGNED); String keywords = ""; List tasks = wlSvc.getWorklistTasks(ctx, keywords, filterMap, IWorklistService.SORT_FIELD_TASK_TITLE, IWorklistService.SORT_ORDER_ASCENDING); // 4. APPROVE all "Vacation Request" tasks that are assigned to user if (tasks != null) { for (int i=0; i < tasks.size(); i++) { Task task = (Task) tasks.get(i); String taskId = task.getTaskId(); // check if the task is a vacation request if (task.getTitle().startsWith("Vacation request")) { wlSvc.appendTaskComments(ctx, taskId, "foo"); // now approve the task String action = "APPROVE"; wlSvc.customTaskOperation(ctx, taskId, action); } } }
All the methods below are tagged with the appropriate method category (e.g., authentication, task action, etc.) Beyond authentication, all methods require the worklist context as the first argument. The worklist context helps the worklist service determine the user requesting the action, whether the user has permission to perform the requested action on the task and so forth. The context also contains information about the user's locale and timezone information. The context maintains timestamps of when the worklist service was last accessed by that user to enforce worklist service session timeouts. This timeout value is configurable and is specified in the system/services/config/pc.propreties file. This value should be same or more than the session timeout value specified for the front end application.
Field Summary | |
static java.lang.String |
ASSIGNEE_TYPE_GROUP The task assignee type for group |
static java.lang.String |
ASSIGNEE_TYPE_REPORTEE The task assignee type for reportee |
static java.lang.String |
ASSIGNEE_TYPE_USER The task assignee type for user |
static java.lang.String |
BUSINESS_PROCESS_FILTER_ANY The business filter option for retrieving tasks from any process |
static java.lang.String |
BUSINESS_PROCESS_FILTER_DEFAULT The default business filter option for retrieving tasks (any process) |
static java.lang.String |
EXP_DATE_FROM_FILTER_DEFAULT The task expiration date option default (empty) |
static java.lang.String |
EXP_DATE_TO_FILTER_DEFAULT The task expiration date option default (empty) |
static java.lang.String |
FILTER_TYPE_BUSINESS_PROCESS_FILTER The filter type for specifying the business process filter |
static java.lang.String |
FILTER_TYPE_CREATE_DATE_FROM_FILTER The filter type for specifying the task creation date (from date) filter |
static java.lang.String |
FILTER_TYPE_CREATE_DATE_TO_FILTER The filter type for specifying the task creation date (to date) filter |
static java.lang.String |
FILTER_TYPE_EXP_DATE_FROM_FILTER The filter type for specifying the task expiration date (from date) filter |
static java.lang.String |
FILTER_TYPE_EXP_DATE_TO_FILTER The filter type for specifying the task expiration date (to date) filter |
static java.lang.String |
FILTER_TYPE_PRIORITY_FILTER The filter type for specifying the task priority filter |
static java.lang.String |
FILTER_TYPE_STATUS_FILTER The filter type for specifying the task status filter |
static java.lang.String |
FILTER_TYPE_TASK_FILTER The filter type for specifying the task (category) filter |
static java.lang.String |
SORT_FIELD_TASK_CONCLUSION The task sort field option for conclusion |
static java.lang.String |
SORT_FIELD_TASK_EXPIRATION_DATE The task sort field option for expiration date |
static java.lang.String |
SORT_FIELD_TASK_MODIFIED_BY The task sort field option for modifying user |
static java.lang.String |
SORT_FIELD_TASK_MODIFIED_DATE The task sort field option for modified date |
static java.lang.String |
SORT_FIELD_TASK_NUMBER The task sort field option for task number |
static java.lang.String |
SORT_FIELD_TASK_PRIORITY The task sort field option for priority |
static java.lang.String |
SORT_FIELD_TASK_STATUS The task sort field option for status |
static java.lang.String |
SORT_FIELD_TASK_TITLE The task sort field option for title |
static java.lang.String |
SORT_OPTION_FIELD The task sort field |
static java.lang.String |
SORT_OPTION_ORDER The task sort order |
static java.lang.String |
SORT_ORDER_ASCENDING The task sort option for ascending order |
static java.lang.String |
SORT_ORDER_DESCENDING The task sort option for descending order |
static java.lang.String |
STATUS_FILTER_ANY The task status option for retrieving tasks with any status |
static java.lang.String |
STATUS_FILTER_ASSIGNED The task status option for retrieving tasks with assigned or info requested status |
static java.lang.String |
STATUS_FILTER_COMPLETED The task status option for retrieving tasks with completed status |
static java.lang.String |
STATUS_FILTER_DEFAULT The default task status option for retrieving tasks (assigned or info requested) status |
static java.lang.String |
STATUS_FILTER_ERRORED The task status option for retrieving tasks with errored status |
static java.lang.String |
STATUS_FILTER_EXPIRED The task status option for retrieving tasks with expired status |
static java.lang.String |
STATUS_FILTER_INFO_REQUESTED The task status option for retrieving tasks with info requested status |
static java.lang.String |
STATUS_FILTER_STALE The task status option for retrieving tasks with stale status |
static java.lang.String |
STATUS_FILTER_SUSPENDED The task status option for retrieving tasks with suspended status |
static java.lang.String |
STATUS_FILTER_WITHDRAWN The task status option for retrieving tasks with withdrawn status |
static java.lang.String |
SUBSTATE_ACQUIRED The task acquired substate |
static java.lang.String |
SUBSTATE_ASSIGNED The task assigned substate |
static java.lang.String |
SUBSTATE_ESCALATED The task escalated substate |
static java.lang.String |
SUBSTATE_INFO_SUBMITTED The task info submitted substate |
static java.lang.String |
SUBSTATE_REASSIGNED The task reassigned substate |
static java.lang.String |
SUBSTATE_RELEASED The task released substate |
static java.lang.String |
SUBSTATE_RENEWED The task renewed substate |
static java.lang.String |
SUBSTATE_RESUMED The task resumed substate |
static java.lang.String |
SUBSTATE_ROUTED The task routed substate |
static java.lang.String |
TASK_ACTION_ACQUIRE The task action for acquiring a task |
static java.lang.String |
TASK_ACTION_APPEND_COMMENTS The task action for appending comments to a task |
static java.lang.String |
TASK_ACTION_CUSTOM The task action for performing custom action on a task |
static java.lang.String |
TASK_ACTION_DELEGATE The task action for delegating a task |
static java.lang.String |
TASK_ACTION_ESCALATE The task action for escalating a task |
static java.lang.String |
TASK_ACTION_REASSIGN The task action for reassigning a task |
static java.lang.String |
TASK_ACTION_RELEASE The task action for releasing a task |
static java.lang.String |
TASK_ACTION_RENEW The task action for renewing a task |
static java.lang.String |
TASK_ACTION_REQ_MORE_INFO The task action for requesting more info on a task |
static java.lang.String |
TASK_ACTION_RESUME The task action for resuming a task |
static java.lang.String |
TASK_ACTION_SUBMIT_MORE_INFO The task action for submitting more info on a task |
static java.lang.String |
TASK_ACTION_SUSPEND The task action for suspending a task |
static java.lang.String |
TASK_ACTION_UPDATE The task action for updating a task |
static java.lang.String |
TASK_ACTION_VIEW_PROCESS_HISTORY The task action for viewing process history of a task |
static java.lang.String |
TASK_ACTION_VIEW_SUB_TASKS The task action for viewing sub tasks of a task |
static java.lang.String |
TASK_ACTION_VIEW_TASK_HISTORY The task action for viewing history of a task |
static java.lang.String |
TASK_ACTION_WITHDRAW The task action for withdrawing a task |
static java.lang.String |
TASK_FILTER_ADMIN The task filter option for retrieving all tasks in the system as an admin |
static java.lang.String |
TASK_FILTER_ALL The task filter option for retrieving all tasks |
static java.lang.String |
TASK_FILTER_CREATOR The task filter option for retrieving tasks where the context user is a creator |
static java.lang.String |
TASK_FILTER_DEFAULT The default task filter option (user and user's group) |
static java.lang.String |
TASK_FILTER_GROUP The task filter option for retrieving tasks assigned to a context user's group(s) |
static java.lang.String |
TASK_FILTER_MY The task filter option for retrieving tasks assigned to a context user |
static java.lang.String |
TASK_FILTER_MY_AND_GROUP The task filter option for retrieving tasks assigned to a context user & user's group(s) |
static java.lang.String |
TASK_FILTER_MY_WORKFLOWS The task filter option for retrieving tasks the context user worked on in the past |
static java.lang.String |
TASK_FILTER_OWNER The task filter option for retrieving tasks where the context user is a owner |
static java.lang.String |
TASK_FILTER_REPORTEES The task filter option for retrieving tasks assigned to the context user's reporteees |
static java.lang.String |
TASK_FUTURE_APPROVERS_TO_BE_DETERMINED |
static java.lang.String |
TASK_PRIORITY_ANY The task priority option for retrieving tasks with any priority |
static java.lang.String |
TASK_PRIORITY_DEFAULT The default task priority option (Any) |
static java.lang.String |
TASK_PRIORITY_FIVE The task priority option for retrieving tasks with priority 5 |
static java.lang.String |
TASK_PRIORITY_FOUR The task priority option for retrieving tasks with priority 4 |
static java.lang.String |
TASK_PRIORITY_ONE The task priority option for retrieving tasks with priority 1 |
static java.lang.String |
TASK_PRIORITY_THREE The task priority option for retrieving tasks with priority 3 |
static java.lang.String |
TASK_PRIORITY_TWO The task priority option for retrieving tasks with priority 2 |
static java.lang.String |
TASK_VERSION_REASON_ACQUIRED The task version (sequence) reason for acquiring task |
static java.lang.String |
TASK_VERSION_REASON_ATTACHMENT_ADDED The task version (sequence) reason for adding attachment to task |
static java.lang.String |
TASK_VERSION_REASON_ATTACHMENT_REMOVED The task version (sequence) reason for removing attachment from task |
static java.lang.String |
TASK_VERSION_REASON_COMMENT_UPDATED The task version (sequence) reason for updating comments on task |
static java.lang.String |
TASK_VERSION_REASON_CONCLUSION_UPDATED The task version (sequence) reason for updating conclusion on task |
static java.lang.String |
TASK_VERSION_REASON_ESCALATED The task version (sequence) reason for escalating task |
static java.lang.String |
TASK_VERSION_REASON_EXPIRED The task version (sequence) reason for expiration of task |
static java.lang.String |
TASK_VERSION_REASON_INFO_REQUESTED The task version (sequence) reason for requesting info on task |
static java.lang.String |
TASK_VERSION_REASON_INFO_SUBMITTED The task version (sequence) reason for submitting info on task |
static java.lang.String |
TASK_VERSION_REASON_INITIATED The task version (sequence) reason for initiating (creating) task |
static java.lang.String |
TASK_VERSION_REASON_REASSIGNED The task version (sequence) reason for reassigning task |
static java.lang.String |
TASK_VERSION_REASON_REINITIATED The task version (sequence) reason for reinitiating (continuing) task |
static java.lang.String |
TASK_VERSION_REASON_RELEASED The task version (sequence) reason for releasing task |
static java.lang.String |
TASK_VERSION_REASON_RENEWED The task version (sequence) reason for renewing task |
static java.lang.String |
TASK_VERSION_REASON_RESUMED The task version (sequence) reason for resuming task |
static java.lang.String |
TASK_VERSION_REASON_ROUTED The task version (sequence) reason for routing task |
static java.lang.String |
TASK_VERSION_REASON_STALE The task version (sequence) reason for task becoming stale (process off/undeployed) |
static java.lang.String |
TASK_VERSION_REASON_SUSPENDED The task version (sequence) reason for suspending task |
static java.lang.String |
TASK_VERSION_REASON_UPDATED The task version (sequence) reason for updating task |
static java.lang.String |
TASK_VERSION_REASON_WITHDRAWN The task version (sequence) reason for withdrawing task |
Method Summary | |
IWorklistTask |
acquireTask(IWorklistContext ctx, java.lang.String taskId) Performs an acquire action on the task with the specified taskId |
void |
addTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String name, java.lang.String value, java.lang.String type, java.io.InputStream dataStream) Adds an attachment to the task with the specified taskId. |
void |
addTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String name, java.lang.String value, java.lang.String type, java.io.InputStream dataStream, java.lang.String boundary) Adds an attachment to the task with the specified taskId. |
IWorklistTask |
appendTaskComments(IWorklistContext ctx, java.lang.String taskId, java.lang.String comments) Appends the comments to the task with the specified taskId. |
IWorklistContext |
authenticateUser(java.lang.String user, java.lang.String password) Authenticates a user based on the provided user and password information. |
IWorklistTask |
completeAndRouteTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String conclusion, java.lang.String comments, java.util.List worklistAssignees) Performs an adhoc route action on the task with the specified taskId. |
IWorklistContext |
createContext(javax.servlet.http.HttpServletRequest request) Creates a worklist context if the request contains an authenticated remote user. |
IWorklistTask |
customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation) Performs a custom action (set conclusion) on the task with the specified taskId |
IWorklistTask |
customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation, java.lang.String comments) Performs a custom action (set conclusion) on the task with the specified taskId |
IWorklistTask |
delegateTask(IWorklistContext ctx, java.lang.String taskId, java.util.List worklistAssignees) Performs a delegate (reassign) action on the task with the specified taskId using the list of worklist assignee |
void |
destroyContext(IWorklistContext ctx) destroyContext recycles a worklist context not needed anymore. |
IWorklistTask |
escalateTask(IWorklistContext ctx, java.lang.String taskId) Performs an escalate action on the task with the specified taskId |
IWorklistContext |
getContext(java.lang.String contextKey) Returns an existing worklist context if the given contextKey is valid. |
IWorklistGroup |
getGroupInfo(IWorklistContext ctx, java.lang.String group) Gets information about the specificied group. |
IWorklistUser |
getUserInfo(IWorklistContext ctx, java.lang.String user) Gets information about the specificied user. |
java.util.List |
getWorklistHistoryIds(IWorklistContext context, IPredicate pred) Returns a List of task ids from the task history table based on the specified IPredicate criterion. |
java.util.List |
getWorklistHistoryIds(IWorklistContext context, IPredicate pred, int startRow, int endRow) Returns a List of task ids from the task history table based on the specified IPredicate criterion. |
java.util.List |
getWorklistTaskBusinessProcesses(IWorklistContext ctx) Returns a list of business processes deployed in the system |
IWorklistTask |
getWorklistTaskById(IWorklistContext context, java.lang.String taskId) Returns a worklist task based on the specified taskId |
IWorklistTask |
getWorklistTaskByNumber(IWorklistContext context, int taskNumber) Returns a worklist task based on the specified task number |
IWorklistTask |
getWorklistTaskDetails(IWorklistContext ctx, java.lang.String taskId) Returns a task (IWorklistTask) with all details (actions, attachment, payload, etc.) of based on the specified taskId |
java.util.List |
getWorklistTaskHistory(IWorklistContext ctx, java.lang.String taskId) Returns a list of history tasks (IWorklistTask) based on the specified taskId |
java.util.List |
getWorklistTasks(IWorklistContext context, IPredicate pred, IOrdering ordering) Returns a List of task (IWorklistTask) objects based on the specified IPredicate and IOrdering criterion. |
java.util.List |
getWorklistTasks(IWorklistContext context, IPredicate pred, IOrdering ordering, int startRow, int endRow) Returns a List of task (IWorklistTask) objects based on the specified IPredicate and IOrdering criterion. |
java.util.List |
getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. |
java.util.List |
getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow) Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. |
java.util.List |
getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. |
java.util.List |
getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow) Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. |
IWorklistTask |
getWorklistTaskVersionDetails(IWorklistContext ctx, java.lang.String taskId, int version) Returns a task (IWorklistTask) with all details (actions, attachment, payload, etc.) of based on the specified taskId and the version |
java.util.List |
lookupAssignees(IWorklistContext ctx, java.lang.String assigneeType, java.lang.String userLookupList) Returns a list of assignee (ITaskAssignee) objects of the specified type that match the userLookupList pattern. |
IWorklistTask |
releaseTask(IWorklistContext ctx, java.lang.String taskId) Performs a release action on the task with the specified taskId |
void |
removeTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String[] names) Removes one or more attachments from the task with the specified taskId. |
IWorklistTask |
renewTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String durationDays) Performs a renew action on the task with the specified taskId |
IWorklistTask |
requestInfoForTask(IWorklistContext ctx, java.lang.String taskId) Performs a request more info action on the task with the specified taskId |
IWorklistTask |
requestInfoForTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String user, boolean reapprovalNeeded, java.lang.String comments) Performs a request more info action on the task with the specified taskId |
IWorklistTask |
resumeTask(IWorklistContext ctx, java.lang.String taskId) Performs a resume action on the task with the specified taskId |
IWorklistTask |
submitInfoForTask(IWorklistContext ctx, java.lang.String taskId) Performs a submit more info action on the task with the specified taskId |
IWorklistTask |
suspendTask(IWorklistContext ctx, java.lang.String taskId) Performs a suspend action on the task with the specified taskId |
void |
updateTask(IWorklistContext ctx, IWorklistTask task) Performs an update action on the task with the specified taskId. |
IWorklistTask |
withdrawTask(IWorklistContext ctx, java.lang.String taskId) Performs a withdraw action on the task with the specified taskId |
Field Detail |
public static final java.lang.String FILTER_TYPE_TASK_FILTER
public static final java.lang.String FILTER_TYPE_PRIORITY_FILTER
public static final java.lang.String FILTER_TYPE_STATUS_FILTER
public static final java.lang.String FILTER_TYPE_EXP_DATE_FROM_FILTER
public static final java.lang.String FILTER_TYPE_EXP_DATE_TO_FILTER
public static final java.lang.String FILTER_TYPE_BUSINESS_PROCESS_FILTER
public static final java.lang.String FILTER_TYPE_CREATE_DATE_FROM_FILTER
public static final java.lang.String FILTER_TYPE_CREATE_DATE_TO_FILTER
public static final java.lang.String TASK_FILTER_ALL
public static final java.lang.String TASK_FILTER_MY
public static final java.lang.String TASK_FILTER_GROUP
public static final java.lang.String TASK_FILTER_MY_AND_GROUP
public static final java.lang.String TASK_FILTER_REPORTEES
public static final java.lang.String TASK_FILTER_CREATOR
public static final java.lang.String TASK_FILTER_OWNER
public static final java.lang.String TASK_FILTER_MY_WORKFLOWS
public static final java.lang.String TASK_FILTER_ADMIN
public static final java.lang.String TASK_FILTER_DEFAULT
public static final java.lang.String TASK_PRIORITY_ANY
public static final java.lang.String TASK_PRIORITY_ONE
public static final java.lang.String TASK_PRIORITY_TWO
public static final java.lang.String TASK_PRIORITY_THREE
public static final java.lang.String TASK_PRIORITY_FOUR
public static final java.lang.String TASK_PRIORITY_FIVE
public static final java.lang.String TASK_PRIORITY_DEFAULT
public static final java.lang.String BUSINESS_PROCESS_FILTER_ANY
public static final java.lang.String BUSINESS_PROCESS_FILTER_DEFAULT
public static final java.lang.String STATUS_FILTER_ANY
public static final java.lang.String STATUS_FILTER_ASSIGNED
public static final java.lang.String STATUS_FILTER_SUSPENDED
public static final java.lang.String STATUS_FILTER_COMPLETED
public static final java.lang.String STATUS_FILTER_WITHDRAWN
public static final java.lang.String STATUS_FILTER_EXPIRED
public static final java.lang.String STATUS_FILTER_ERRORED
public static final java.lang.String STATUS_FILTER_INFO_REQUESTED
public static final java.lang.String STATUS_FILTER_STALE
public static final java.lang.String STATUS_FILTER_DEFAULT
public static final java.lang.String EXP_DATE_FROM_FILTER_DEFAULT
public static final java.lang.String EXP_DATE_TO_FILTER_DEFAULT
public static final java.lang.String SORT_OPTION_FIELD
public static final java.lang.String SORT_OPTION_ORDER
public static final java.lang.String SORT_FIELD_TASK_NUMBER
public static final java.lang.String SORT_FIELD_TASK_TITLE
public static final java.lang.String SORT_FIELD_TASK_PRIORITY
public static final java.lang.String SORT_FIELD_TASK_STATUS
public static final java.lang.String SORT_FIELD_TASK_EXPIRATION_DATE
public static final java.lang.String SORT_FIELD_TASK_CONCLUSION
public static final java.lang.String SORT_FIELD_TASK_MODIFIED_DATE
public static final java.lang.String SORT_FIELD_TASK_MODIFIED_BY
public static final java.lang.String SORT_ORDER_ASCENDING
public static final java.lang.String SORT_ORDER_DESCENDING
public static final java.lang.String TASK_ACTION_ESCALATE
public static final java.lang.String TASK_ACTION_RENEW
public static final java.lang.String TASK_ACTION_DELEGATE
public static final java.lang.String TASK_ACTION_REASSIGN
public static final java.lang.String TASK_ACTION_ACQUIRE
public static final java.lang.String TASK_ACTION_RELEASE
public static final java.lang.String TASK_ACTION_REQ_MORE_INFO
public static final java.lang.String TASK_ACTION_SUBMIT_MORE_INFO
public static final java.lang.String TASK_ACTION_SUSPEND
public static final java.lang.String TASK_ACTION_RESUME
public static final java.lang.String TASK_ACTION_WITHDRAW
public static final java.lang.String TASK_ACTION_UPDATE
public static final java.lang.String TASK_ACTION_CUSTOM
public static final java.lang.String TASK_ACTION_APPEND_COMMENTS
public static final java.lang.String TASK_ACTION_VIEW_TASK_HISTORY
public static final java.lang.String TASK_ACTION_VIEW_PROCESS_HISTORY
public static final java.lang.String TASK_ACTION_VIEW_SUB_TASKS
public static final java.lang.String ASSIGNEE_TYPE_USER
public static final java.lang.String ASSIGNEE_TYPE_GROUP
public static final java.lang.String ASSIGNEE_TYPE_REPORTEE
public static final java.lang.String TASK_VERSION_REASON_INITIATED
public static final java.lang.String TASK_VERSION_REASON_REINITIATED
public static final java.lang.String TASK_VERSION_REASON_ACQUIRED
public static final java.lang.String TASK_VERSION_REASON_REASSIGNED
public static final java.lang.String TASK_VERSION_REASON_ESCALATED
public static final java.lang.String TASK_VERSION_REASON_RELEASED
public static final java.lang.String TASK_VERSION_REASON_RENEWED
public static final java.lang.String TASK_VERSION_REASON_RESUMED
public static final java.lang.String TASK_VERSION_REASON_ROUTED
public static final java.lang.String TASK_VERSION_REASON_SUSPENDED
public static final java.lang.String TASK_VERSION_REASON_EXPIRED
public static final java.lang.String TASK_VERSION_REASON_UPDATED
public static final java.lang.String TASK_VERSION_REASON_WITHDRAWN
public static final java.lang.String TASK_VERSION_REASON_ATTACHMENT_ADDED
public static final java.lang.String TASK_VERSION_REASON_ATTACHMENT_REMOVED
public static final java.lang.String TASK_VERSION_REASON_COMMENT_UPDATED
public static final java.lang.String TASK_VERSION_REASON_CONCLUSION_UPDATED
public static final java.lang.String TASK_VERSION_REASON_INFO_REQUESTED
public static final java.lang.String TASK_VERSION_REASON_INFO_SUBMITTED
public static final java.lang.String TASK_VERSION_REASON_STALE
public static final java.lang.String TASK_FUTURE_APPROVERS_TO_BE_DETERMINED
public static final java.lang.String SUBSTATE_ASSIGNED
public static final java.lang.String SUBSTATE_REASSIGNED
public static final java.lang.String SUBSTATE_ROUTED
public static final java.lang.String SUBSTATE_RENEWED
public static final java.lang.String SUBSTATE_ESCALATED
public static final java.lang.String SUBSTATE_RESUMED
public static final java.lang.String SUBSTATE_INFO_SUBMITTED
public static final java.lang.String SUBSTATE_ACQUIRED
public static final java.lang.String SUBSTATE_RELEASED
Method Detail |
public IWorklistContext createContext(javax.servlet.http.HttpServletRequest request) throws PCException, WorklistServiceException
request
- the servletRequest containing the remote user informationPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicepublic IWorklistContext authenticateUser(java.lang.String user, java.lang.String password) throws PCException, WorklistServiceException
user
- the name of the userpassword
- the password for the specified userPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicepublic IWorklistGroup getGroupInfo(IWorklistContext ctx, java.lang.String group) throws PCException, WorklistServiceException
ctx
- a valid worklist contextgroup
- the name of the group for which info is neededPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicepublic IWorklistUser getUserInfo(IWorklistContext ctx, java.lang.String user) throws PCException, WorklistServiceException
ctx
- a valid worklist contextuser
- the name of the user for which info is neededPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicepublic java.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) throws PCException, WorklistServiceException
ctx
- a valid worklist contextfilterMap
- a map specifying the filter types and their valuessortField
- the task field to be used for sorting the taskssortOrder
- the sort order to be used for sorting the tasksPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic java.util.List getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) throws PCException, WorklistServiceException
ctx
- a valid worklist contextkeywords
- search string to be used while filteringfilterMap
- a map specifying the filter types and their valuessortField
- the task field to be used for sorting the taskssortOrder
- the sort order to be used for sorting the tasksPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic java.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow) throws PCException, WorklistServiceException
ctx
- a valid worklist contextfilterMap
- a map specifying the filter types and their valuessortField
- the task field to be used for sorting the taskssortOrder
- the sort order to be used for sorting the tasksstartRow
- the row number of the first row in the result set (for paging)lastRow
- the row number of the last row in the result set (for paging)PCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic java.util.List getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow) throws PCException, WorklistServiceException
ctx
- a valid worklist contextkeywords
- search string to be used while filteringfilterMap
- a map specifying the filter types and their valuessortField
- the task field to be used for sorting the taskssortOrder
- the sort order to be used for sorting the tasksstartRow
- the row number of the first row in the result set (for paging)lastRow
- the row number of the last row in the result set (for paging)PCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic IWorklistTask getWorklistTaskDetails(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic IWorklistTask getWorklistTaskVersionDetails(IWorklistContext ctx, java.lang.String taskId, int version) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskversion
- the version number of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic java.util.List getWorklistTaskHistory(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic java.util.List getWorklistTaskBusinessProcesses(IWorklistContext ctx) throws PCException, WorklistServiceException
ctx
- a valid worklist contextPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicepublic IWorklistTask acquireTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask releaseTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask escalateTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask renewTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String durationDays) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskdurationDays
- the renew duration for the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask withdrawTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask suspendTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask resumeTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask requestInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask requestInfoForTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String user, boolean reapprovalNeeded, java.lang.String comments) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskuser
- the user from whom to request more informationreapprovalNeeded
- flag indicating if repproval is needed in the approval chaincomments
- task comments if any for this actionPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask submitInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask delegateTask(IWorklistContext ctx, java.lang.String taskId, java.util.List worklistAssignees) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskworklistAssignees
- a list of ITaskAssignee objects (chosen using identity lookup)PCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskoperation
- the name of the custom action (should be a valid conclusion)PCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation, java.lang.String comments) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskoperation
- the name of the custom action (should be a valid conclusion)comments
- task comments if any for this actionPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask completeAndRouteTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String conclusion, java.lang.String comments, java.util.List worklistAssignees) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskconclusion
- the name of the conclusioncomments
- task comments if any for this actionworklistAssignees
- a list of ITaskAssignee objects (chosen using identity lookup)PCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic void updateTask(IWorklistContext ctx, IWorklistTask task) throws PCException, WorklistServiceException
ctx
- a valid worklist contextPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistTask appendTaskComments(IWorklistContext ctx, java.lang.String taskId, java.lang.String comments) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskcomments
- new task commentsPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic void addTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String name, java.lang.String value, java.lang.String type, java.io.InputStream dataStream, java.lang.String boundary) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskname
- the name of the task attachmentvalue
- the value of the task attachment (URL -- needed only for URL attachment)type
- the type of the attachment (File or URL)dataStream
- the dataStream from which to read the contentsboundary
- the boundary string in the dataStreamPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic void addTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String name, java.lang.String value, java.lang.String type, java.io.InputStream dataStream) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the taskname
- the name of the task attachmentvalue
- the value of the task attachment (URL -- needed only for URL attachment)type
- the type of the attachment (File or URL -- ATTACHMENT_TYPE_* constant defined in ITaskAttachment)dataStream
- the dataStream from which to read the contentsPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic void removeTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String[] names) throws PCException, WorklistServiceException
ctx
- a valid worklist contexttaskId
- the id of the tasknames
- a string array of attachment names to be removedPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic java.util.List lookupAssignees(IWorklistContext ctx, java.lang.String assigneeType, java.lang.String userLookupList) throws PCException, WorklistServiceException
ctx
- a valid worklist contextassigneeType
- the type of assignees to search (one of above listed ASSIGNEE_TYPE_* constants)userLookupList
- a string pattern for lookupPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic IWorklistContext getContext(java.lang.String contextKey) throws PCException, WorklistServiceException
contextKey
- a valid worklist context keyPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- if user does not have permission to perform this action or if any exception is encountered by the Worklist Servicepublic void destroyContext(IWorklistContext ctx)
public IWorklistTask getWorklistTaskById(IWorklistContext context, java.lang.String taskId) throws PCException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicespublic IWorklistTask getWorklistTaskByNumber(IWorklistContext context, int taskNumber) throws PCException
context
- a valid worklist contexttaskNumber
- the number of the taskPCException
- any exception thrown by the Identity Service or other internal servicespublic java.util.List getWorklistTasks(IWorklistContext context, IPredicate pred, IOrdering ordering, int startRow, int endRow) throws PCException
context
- a valid worklist contextpred
- a valid IPredicate object representing the filter criterionordering
- a valid IOrdering object representing the sorting criterionstartRow
- the row number of the first row in the result set (for paging)PCException
public java.util.List getWorklistTasks(IWorklistContext context, IPredicate pred, IOrdering ordering) throws PCException
context
- a valid worklist contextpred
- a valid IPredicate object representing the filter criterionordering
- a valid IOrdering object representing the sorting criterionPCException
public java.util.List getWorklistHistoryIds(IWorklistContext context, IPredicate pred, int startRow, int endRow) throws PCException
context
- a valid worklist contextpred
- a valid IPredicate object representing the filter criterionstartRow
- the row number of the first row in the result set (for paging)PCException
public java.util.List getWorklistHistoryIds(IWorklistContext context, IPredicate pred) throws PCException
context
- a valid worklist contextpred
- a valid IPredicate object representing the filter criterionPCException
|
Oracle BPEL Process Manager Workflow Services API Reference 10g Release 2 (10.1.2) B25708-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |