|
Oracle Fusion Middleware Workflow Services Java API Reference for Oracle SOA Suite 11g Release 1 (11.1.1.5.0) E10660-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Deprecated. Replaced by ITaskService
, ITaskQueryService
and other interfaces in oracle.bpel.services.workflow package
public interface IWorklistService
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 Deprecated. The task assignee type for group |
static java.lang.String |
ASSIGNEE_TYPE_REPORTEE Deprecated. The task assignee type for reportee |
static java.lang.String |
ASSIGNEE_TYPE_USER Deprecated. The task assignee type for user |
static java.lang.String |
BUSINESS_PROCESS_FILTER_ANY Deprecated. The business filter option for retrieving tasks from any process |
static java.lang.String |
BUSINESS_PROCESS_FILTER_DEFAULT Deprecated. The default business filter option for retrieving tasks (any process) |
static java.lang.String |
EXP_DATE_FROM_FILTER_DEFAULT Deprecated. The task expiration date option default (empty) |
static java.lang.String |
EXP_DATE_TO_FILTER_DEFAULT Deprecated. The task expiration date option default (empty) |
static java.lang.String |
FILTER_TYPE_BUSINESS_PROCESS_FILTER Deprecated. The filter type for specifying the business process filter |
static java.lang.String |
FILTER_TYPE_CREATE_DATE_FROM_FILTER Deprecated. The filter type for specifying the task creation date (from date) filter |
static java.lang.String |
FILTER_TYPE_CREATE_DATE_TO_FILTER Deprecated. The filter type for specifying the task creation date (to date) filter |
static java.lang.String |
FILTER_TYPE_END_DATE_FROM_FILTER Deprecated. The filter type for specifying the task completion date (from date) filter |
static java.lang.String |
FILTER_TYPE_END_DATE_TO_FILTER Deprecated. The filter type for specifying the task completion date (to date) filter |
static java.lang.String |
FILTER_TYPE_EXP_DATE_FROM_FILTER Deprecated. The filter type for specifying the task expiration date (from date) filter |
static java.lang.String |
FILTER_TYPE_EXP_DATE_TO_FILTER Deprecated. The filter type for specifying the task expiration date (to date) filter |
static java.lang.String |
FILTER_TYPE_PRIORITY_FILTER Deprecated. The filter type for specifying the task priority filter |
static java.lang.String |
FILTER_TYPE_STATUS_FILTER Deprecated. The filter type for specifying the task status filter |
static java.lang.String |
FILTER_TYPE_TASK_ACQUIREDBY_FILTER Deprecated. The filter type for specifying the task is acquired by filter |
static java.lang.String |
FILTER_TYPE_TASK_ASSIGNEE_FILTER Deprecated. The filter type for specifying the task assignee filter |
static java.lang.String |
FILTER_TYPE_TASK_FILTER Deprecated. The filter type for specifying the task (category) filter |
static java.lang.String |
FILTER_TYPE_TASK_ISGROUP_FILTER Deprecated. The filter type for specifying the task is assigned to a group filter |
static java.lang.String |
SORT_FIELD_TASK_CONCLUSION Deprecated. The task sort field option for conclusion |
static java.lang.String |
SORT_FIELD_TASK_EXPIRATION_DATE Deprecated. The task sort field option for expiration date |
static java.lang.String |
SORT_FIELD_TASK_MODIFIED_BY Deprecated. The task sort field option for modifying user |
static java.lang.String |
SORT_FIELD_TASK_MODIFIED_DATE Deprecated. The task sort field option for modified date |
static java.lang.String |
SORT_FIELD_TASK_NUMBER Deprecated. The task sort field option for task number |
static java.lang.String |
SORT_FIELD_TASK_PRIORITY Deprecated. The task sort field option for priority |
static java.lang.String |
SORT_FIELD_TASK_STATUS Deprecated. The task sort field option for status |
static java.lang.String |
SORT_FIELD_TASK_TITLE Deprecated. The task sort field option for title |
static java.lang.String |
SORT_OPTION_FIELD Deprecated. The task sort field |
static java.lang.String |
SORT_OPTION_ORDER Deprecated. The task sort order |
static java.lang.String |
SORT_ORDER_ASCENDING Deprecated. The task sort option for ascending order |
static java.lang.String |
SORT_ORDER_DESCENDING Deprecated. The task sort option for descending order |
static java.lang.String |
STATUS_FILTER_ANY Deprecated. The task status option for retrieving tasks with any status |
static java.lang.String |
STATUS_FILTER_ASSIGNED Deprecated. The task status option for retrieving tasks with assigned or info requested status |
static java.lang.String |
STATUS_FILTER_COMPLETED Deprecated. The task status option for retrieving tasks with completed status |
static java.lang.String |
STATUS_FILTER_DEFAULT Deprecated. The default task status option for retrieving tasks (assigned or info requested) status |
static java.lang.String |
STATUS_FILTER_ERRORED Deprecated. The task status option for retrieving tasks with errored status |
static java.lang.String |
STATUS_FILTER_EXPIRED Deprecated. The task status option for retrieving tasks with expired status |
static java.lang.String |
STATUS_FILTER_INFO_REQUESTED Deprecated. The task status option for retrieving tasks with info requested status |
static java.lang.String |
STATUS_FILTER_STALE Deprecated. The task status option for retrieving tasks with stale status |
static java.lang.String |
STATUS_FILTER_SUSPENDED Deprecated. The task status option for retrieving tasks with suspended status |
static java.lang.String |
STATUS_FILTER_WITHDRAWN Deprecated. The task status option for retrieving tasks with withdrawn status |
static java.lang.String |
SUBSTATE_ACQUIRED Deprecated. The task acquired substate |
static java.lang.String |
SUBSTATE_ASSIGNED Deprecated. The task assigned substate |
static java.lang.String |
SUBSTATE_ESCALATED Deprecated. The task escalated substate |
static java.lang.String |
SUBSTATE_INFO_SUBMITTED Deprecated. The task info submitted substate |
static java.lang.String |
SUBSTATE_REASSIGNED Deprecated. The task reassigned substate |
static java.lang.String |
SUBSTATE_RELEASED Deprecated. The task released substate |
static java.lang.String |
SUBSTATE_RENEWED Deprecated. The task renewed substate |
static java.lang.String |
SUBSTATE_RESUMED Deprecated. The task resumed substate |
static java.lang.String |
SUBSTATE_ROUTED Deprecated. The task routed substate |
static java.lang.String |
TASK_ACTION_ACQUIRE Deprecated. The task action for acquiring a task |
static java.lang.String |
TASK_ACTION_APPEND_COMMENTS Deprecated. The task action for appending comments to a task |
static java.lang.String |
TASK_ACTION_CUSTOM Deprecated. The task action for performing custom action on a task |
static java.lang.String |
TASK_ACTION_DELEGATE Deprecated. The task action for delegating a task |
static java.lang.String |
TASK_ACTION_ESCALATE Deprecated. The task action for escalating a task |
static java.lang.String |
TASK_ACTION_REASSIGN Deprecated. The task action for reassigning a task |
static java.lang.String |
TASK_ACTION_RELEASE Deprecated. The task action for releasing a task |
static java.lang.String |
TASK_ACTION_RENEW Deprecated. The task action for renewing a task |
static java.lang.String |
TASK_ACTION_REQ_MORE_INFO Deprecated. The task action for requesting more info on a task |
static java.lang.String |
TASK_ACTION_RESUME Deprecated. The task action for resuming a task |
static java.lang.String |
TASK_ACTION_SUBMIT_MORE_INFO Deprecated. The task action for submitting more info on a task |
static java.lang.String |
TASK_ACTION_SUSPEND Deprecated. The task action for suspending a task |
static java.lang.String |
TASK_ACTION_UPDATE Deprecated. The task action for updating a task |
static java.lang.String |
TASK_ACTION_VIEW_PROCESS_HISTORY Deprecated. The task action for viewing process history of a task |
static java.lang.String |
TASK_ACTION_VIEW_SUB_TASKS Deprecated. The task action for viewing sub tasks of a task |
static java.lang.String |
TASK_ACTION_VIEW_TASK_HISTORY Deprecated. The task action for viewing history of a task |
static java.lang.String |
TASK_ACTION_WITHDRAW Deprecated. The task action for withdrawing a task |
static java.lang.String |
TASK_FILTER_ADMIN Deprecated. The task filter option for retrieving all tasks in the system as an admin |
static java.lang.String |
TASK_FILTER_ALL Deprecated. The task filter option for retrieving all tasks |
static java.lang.String |
TASK_FILTER_CREATOR Deprecated. The task filter option for retrieving tasks where the context user is a creator |
static java.lang.String |
TASK_FILTER_DEFAULT Deprecated. The default task filter option (user and user's group) |
static java.lang.String |
TASK_FILTER_GROUP Deprecated. The task filter option for retrieving tasks assigned to a context user's group(s) |
static java.lang.String |
TASK_FILTER_MY Deprecated. The task filter option for retrieving tasks assigned to a context user |
static java.lang.String |
TASK_FILTER_MY_AND_GROUP Deprecated. The task filter option for retrieving tasks assigned to a context user & user's group(s) |
static java.lang.String |
TASK_FILTER_MY_WORKFLOWS Deprecated. The task filter option for retrieving tasks the context user worked on in the past |
static java.lang.String |
TASK_FILTER_OWNER Deprecated. The task filter option for retrieving tasks where the context user is a owner |
static java.lang.String |
TASK_FILTER_REPORTEES Deprecated. The task filter option for retrieving tasks assigned to the context user's reporteees |
static java.lang.String |
TASK_FUTURE_APPROVERS_TO_BE_DETERMINED Deprecated. |
static java.lang.String |
TASK_PRIORITY_ANY Deprecated. The task priority option for retrieving tasks with any priority |
static java.lang.String |
TASK_PRIORITY_DEFAULT Deprecated. The default task priority option (Any) |
static java.lang.String |
TASK_PRIORITY_FIVE Deprecated. The task priority option for retrieving tasks with priority 5 |
static java.lang.String |
TASK_PRIORITY_FOUR Deprecated. The task priority option for retrieving tasks with priority 4 |
static java.lang.String |
TASK_PRIORITY_ONE Deprecated. The task priority option for retrieving tasks with priority 1 |
static java.lang.String |
TASK_PRIORITY_THREE Deprecated. The task priority option for retrieving tasks with priority 3 |
static java.lang.String |
TASK_PRIORITY_TWO Deprecated. The task priority option for retrieving tasks with priority 2 |
static java.lang.String |
TASK_VERSION_REASON_ACQUIRED Deprecated. The task version (sequence) reason for acquiring task |
static java.lang.String |
TASK_VERSION_REASON_ATTACHMENT_ADDED Deprecated. The task version (sequence) reason for adding attachment to task |
static java.lang.String |
TASK_VERSION_REASON_ATTACHMENT_REMOVED Deprecated. The task version (sequence) reason for removing attachment from task |
static java.lang.String |
TASK_VERSION_REASON_COMMENT_UPDATED Deprecated. The task version (sequence) reason for updating comments on task |
static java.lang.String |
TASK_VERSION_REASON_CONCLUSION_UPDATED Deprecated. The task version (sequence) reason for updating conclusion on task |
static java.lang.String |
TASK_VERSION_REASON_ESCALATED Deprecated. The task version (sequence) reason for escalating task |
static java.lang.String |
TASK_VERSION_REASON_EXPIRED Deprecated. The task version (sequence) reason for expiration of task |
static java.lang.String |
TASK_VERSION_REASON_INFO_REQUESTED Deprecated. The task version (sequence) reason for requesting info on task |
static java.lang.String |
TASK_VERSION_REASON_INFO_SUBMITTED Deprecated. The task version (sequence) reason for submitting info on task |
static java.lang.String |
TASK_VERSION_REASON_INITIATED Deprecated. The task version (sequence) reason for initiating (creating) task |
static java.lang.String |
TASK_VERSION_REASON_REASSIGNED Deprecated. The task version (sequence) reason for reassigning task |
static java.lang.String |
TASK_VERSION_REASON_REINITIATED Deprecated. The task version (sequence) reason for reinitiating (continuing) task |
static java.lang.String |
TASK_VERSION_REASON_RELEASED Deprecated. The task version (sequence) reason for releasing task |
static java.lang.String |
TASK_VERSION_REASON_RENEWED Deprecated. The task version (sequence) reason for renewing task |
static java.lang.String |
TASK_VERSION_REASON_RESUMED Deprecated. The task version (sequence) reason for resuming task |
static java.lang.String |
TASK_VERSION_REASON_ROUTED Deprecated. The task version (sequence) reason for routing task |
static java.lang.String |
TASK_VERSION_REASON_STALE Deprecated. The task version (sequence) reason for task becoming stale (process off/undeployed) |
static java.lang.String |
TASK_VERSION_REASON_SUSPENDED Deprecated. The task version (sequence) reason for suspending task |
static java.lang.String |
TASK_VERSION_REASON_UPDATED Deprecated. The task version (sequence) reason for updating task |
static java.lang.String |
TASK_VERSION_REASON_WITHDRAWN Deprecated. The task version (sequence) reason for withdrawing task |
Field Detail |
---|
static final java.lang.String FILTER_TYPE_TASK_FILTER
static final java.lang.String FILTER_TYPE_PRIORITY_FILTER
static final java.lang.String FILTER_TYPE_STATUS_FILTER
static final java.lang.String FILTER_TYPE_EXP_DATE_FROM_FILTER
static final java.lang.String FILTER_TYPE_EXP_DATE_TO_FILTER
static final java.lang.String FILTER_TYPE_END_DATE_FROM_FILTER
static final java.lang.String FILTER_TYPE_END_DATE_TO_FILTER
static final java.lang.String FILTER_TYPE_BUSINESS_PROCESS_FILTER
static final java.lang.String FILTER_TYPE_CREATE_DATE_FROM_FILTER
static final java.lang.String FILTER_TYPE_CREATE_DATE_TO_FILTER
static final java.lang.String FILTER_TYPE_TASK_ISGROUP_FILTER
static final java.lang.String FILTER_TYPE_TASK_ACQUIREDBY_FILTER
static final java.lang.String FILTER_TYPE_TASK_ASSIGNEE_FILTER
static final java.lang.String TASK_FILTER_ALL
static final java.lang.String TASK_FILTER_MY
static final java.lang.String TASK_FILTER_GROUP
static final java.lang.String TASK_FILTER_MY_AND_GROUP
static final java.lang.String TASK_FILTER_REPORTEES
static final java.lang.String TASK_FILTER_CREATOR
static final java.lang.String TASK_FILTER_OWNER
static final java.lang.String TASK_FILTER_MY_WORKFLOWS
static final java.lang.String TASK_FILTER_ADMIN
static final java.lang.String TASK_FILTER_DEFAULT
static final java.lang.String TASK_PRIORITY_ANY
static final java.lang.String TASK_PRIORITY_ONE
static final java.lang.String TASK_PRIORITY_TWO
static final java.lang.String TASK_PRIORITY_THREE
static final java.lang.String TASK_PRIORITY_FOUR
static final java.lang.String TASK_PRIORITY_FIVE
static final java.lang.String TASK_PRIORITY_DEFAULT
static final java.lang.String BUSINESS_PROCESS_FILTER_ANY
static final java.lang.String BUSINESS_PROCESS_FILTER_DEFAULT
static final java.lang.String STATUS_FILTER_ANY
static final java.lang.String STATUS_FILTER_ASSIGNED
static final java.lang.String STATUS_FILTER_SUSPENDED
static final java.lang.String STATUS_FILTER_COMPLETED
static final java.lang.String STATUS_FILTER_WITHDRAWN
static final java.lang.String STATUS_FILTER_EXPIRED
static final java.lang.String STATUS_FILTER_ERRORED
static final java.lang.String STATUS_FILTER_INFO_REQUESTED
static final java.lang.String STATUS_FILTER_STALE
static final java.lang.String STATUS_FILTER_DEFAULT
static final java.lang.String EXP_DATE_FROM_FILTER_DEFAULT
static final java.lang.String EXP_DATE_TO_FILTER_DEFAULT
static final java.lang.String SORT_OPTION_FIELD
static final java.lang.String SORT_OPTION_ORDER
static final java.lang.String SORT_FIELD_TASK_NUMBER
static final java.lang.String SORT_FIELD_TASK_TITLE
static final java.lang.String SORT_FIELD_TASK_PRIORITY
static final java.lang.String SORT_FIELD_TASK_STATUS
static final java.lang.String SORT_FIELD_TASK_EXPIRATION_DATE
static final java.lang.String SORT_FIELD_TASK_CONCLUSION
static final java.lang.String SORT_FIELD_TASK_MODIFIED_DATE
static final java.lang.String SORT_FIELD_TASK_MODIFIED_BY
static final java.lang.String SORT_ORDER_ASCENDING
static final java.lang.String SORT_ORDER_DESCENDING
static final java.lang.String TASK_ACTION_ESCALATE
static final java.lang.String TASK_ACTION_RENEW
static final java.lang.String TASK_ACTION_DELEGATE
static final java.lang.String TASK_ACTION_REASSIGN
static final java.lang.String TASK_ACTION_ACQUIRE
static final java.lang.String TASK_ACTION_RELEASE
static final java.lang.String TASK_ACTION_REQ_MORE_INFO
static final java.lang.String TASK_ACTION_SUBMIT_MORE_INFO
static final java.lang.String TASK_ACTION_SUSPEND
static final java.lang.String TASK_ACTION_RESUME
static final java.lang.String TASK_ACTION_WITHDRAW
static final java.lang.String TASK_ACTION_UPDATE
static final java.lang.String TASK_ACTION_CUSTOM
static final java.lang.String TASK_ACTION_APPEND_COMMENTS
static final java.lang.String TASK_ACTION_VIEW_TASK_HISTORY
static final java.lang.String TASK_ACTION_VIEW_PROCESS_HISTORY
static final java.lang.String TASK_ACTION_VIEW_SUB_TASKS
static final java.lang.String ASSIGNEE_TYPE_USER
static final java.lang.String ASSIGNEE_TYPE_GROUP
static final java.lang.String ASSIGNEE_TYPE_REPORTEE
static final java.lang.String TASK_VERSION_REASON_INITIATED
static final java.lang.String TASK_VERSION_REASON_REINITIATED
static final java.lang.String TASK_VERSION_REASON_ACQUIRED
static final java.lang.String TASK_VERSION_REASON_REASSIGNED
static final java.lang.String TASK_VERSION_REASON_ESCALATED
static final java.lang.String TASK_VERSION_REASON_RELEASED
static final java.lang.String TASK_VERSION_REASON_RENEWED
static final java.lang.String TASK_VERSION_REASON_RESUMED
static final java.lang.String TASK_VERSION_REASON_ROUTED
static final java.lang.String TASK_VERSION_REASON_SUSPENDED
static final java.lang.String TASK_VERSION_REASON_EXPIRED
static final java.lang.String TASK_VERSION_REASON_UPDATED
static final java.lang.String TASK_VERSION_REASON_WITHDRAWN
static final java.lang.String TASK_VERSION_REASON_ATTACHMENT_ADDED
static final java.lang.String TASK_VERSION_REASON_ATTACHMENT_REMOVED
static final java.lang.String TASK_VERSION_REASON_COMMENT_UPDATED
static final java.lang.String TASK_VERSION_REASON_CONCLUSION_UPDATED
static final java.lang.String TASK_VERSION_REASON_INFO_REQUESTED
static final java.lang.String TASK_VERSION_REASON_INFO_SUBMITTED
static final java.lang.String TASK_VERSION_REASON_STALE
static final java.lang.String TASK_FUTURE_APPROVERS_TO_BE_DETERMINED
static final java.lang.String SUBSTATE_ASSIGNED
static final java.lang.String SUBSTATE_REASSIGNED
static final java.lang.String SUBSTATE_ROUTED
static final java.lang.String SUBSTATE_RENEWED
static final java.lang.String SUBSTATE_ESCALATED
static final java.lang.String SUBSTATE_RESUMED
static final java.lang.String SUBSTATE_INFO_SUBMITTED
static final java.lang.String SUBSTATE_ACQUIRED
static final java.lang.String SUBSTATE_RELEASED
Method Detail |
---|
IWorklistContext createContext(HttpServletRequest request) throws PCException, WorklistServiceException
ITaskQueryService.createContext(HttpServletRequest)
Creates a worklist context if the request contains an authenticated remote user.
request
- the servletRequest containing the remote user informationPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist ServiceIWorklistContext authenticateUser(java.lang.String user, java.lang.String password) throws PCException, WorklistServiceException
ITaskQueryService.authenticate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
Authenticates a user based on the provided user and password information. Upon successful authentication a new worklist context is created.
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 ServiceIWorklistGroup 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 ServiceIWorklistUser 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 Servicejava.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) throws PCException, WorklistServiceException
ITaskQueryService.queryTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.util.List, java.util.List, java.lang.String, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int)
Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. The filterMap contains filter types and their associated values. Filter type can be one of the FILTER_TYPE_* constants listed above. The filterMap should contain an entry of type (FILTER_TYPE_TASK_FILTER) for task (category) filter. Additional filter types can be specified optionally. The tasks returned are sorted by the sortField and ordered by the sortOrder.
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 Servicejava.util.List getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) throws PCException, WorklistServiceException
ITaskQueryService.queryTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.util.List, java.util.List, java.lang.String, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int)
Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. A search string can be specified for the keywords parameter. The filterMap contains filter types and their associated values. Filter type can be one of the FILTER_TYPE_* constants listed above. The filterMap should contain an entry of type (FILTER_TYPE_TASK_FILTER) for task (category) filter. Additional filter types can be specified optionally. The tasks returned are sorted by the sortField and ordered by the sortOrder.
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 Servicejava.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow) throws PCException, WorklistServiceException
ITaskQueryService.queryTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.util.List, java.util.List, java.lang.String, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int)
Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. The filterMap contains filter types and their associated values. Filter type can be one of the FILTER_TYPE_* constants listed above. The filterMap should contain an entry of type (FILTER_TYPE_TASK_FILTER) for task (category) filter. Additional filter types can be specified optionally. The tasks returned are sorted by the sortField and ordered by the sortOrder. A range of tasks from the qualifying result set is retrieved. The startRow specifies the first row in the result set to be retrieved and the lastRow specifies the last row.
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 Servicejava.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
ITaskQueryService.queryTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.util.List, java.util.List, java.lang.String, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int)
Returns a list of tasks (IWorklistTask) that match the filter criterion specified in the filterMap. A search string can be specified for the keywords parameter. The filterMap contains filter types and their associated values. Filter type can be one of the FILTER_TYPE_* constants listed above. The filterMap should contain an entry of type (FILTER_TYPE_TASK_FILTER) for task (category) filter. Additional filter types can be specified optionally. The tasks returned are sorted by the sortField and ordered by the sortOrder. A range of tasks from the qualifying result set is retrieved. The startRow specifies the first row in the result set to be retrieved and the lastRow specifies the last row.
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 ServiceIWorklistTask getWorklistTaskDetails(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a task (IWorklistTask) with all details (actions, attachment, payload, etc.) of based on the specified taskId
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 ServiceIWorklistTask getWorklistTaskVersionDetails(IWorklistContext ctx, java.lang.String taskId, int version) throws PCException, WorklistServiceException
ITaskQueryService.getTaskVersionDetails(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, int)
Returns a task (IWorklistTask) with all details (actions, attachment, payload, etc.) of based on the specified taskId and the version
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 Servicejava.util.List getWorklistTaskHistory(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a list of history tasks (IWorklistTask) based on the specified taskId
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 Servicejava.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 ServiceIWorklistTask acquireTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.acquireTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs an acquire action on the task with the specified taskId
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 ServiceIWorklistTask releaseTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.releaseTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs a release action on the task with the specified taskId
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 ServiceIWorklistTask escalateTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.escalateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs an escalate action on the task with the specified taskId
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 ServiceIWorklistTask renewTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String durationDays) throws PCException, WorklistServiceException
ITaskService.renewTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.impl.Duration)
Performs a renew action on the task with the specified taskId
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 ServiceIWorklistTask withdrawTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.withdrawTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs a withdraw action on the task with the specified taskId
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 ServiceIWorklistTask suspendTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.suspendTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs a suspend action on the task with the specified taskId
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 ServiceIWorklistTask resumeTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.resumeTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs a resume action on the task with the specified taskId
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 ServiceIWorklistTask requestInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.requestInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.ITaskAssignee)
Performs a request more info action on the task with the specified taskId
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 ServiceIWorklistTask requestInfoForTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String user, boolean reapprovalNeeded, java.lang.String comments) throws PCException, WorklistServiceException
ITaskService.requestInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.ITaskAssignee)
Performs a request more info action on the task with the specified taskId
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 ServiceIWorklistTask submitInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws PCException, WorklistServiceException
ITaskService.submitInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs a submit more info action on the task with the specified taskId
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 ServiceIWorklistTask delegateTask(IWorklistContext ctx, java.lang.String taskId, java.util.List worklistAssignees) throws PCException, WorklistServiceException
ITaskService.delegateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, java.util.List)
Performs a delegate (reassign) action on the task with the specified taskId using the list of worklist assignee
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 ServiceIWorklistTask 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 ServiceIWorklistTask 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 ServiceIWorklistTask completeAndRouteTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String conclusion, java.lang.String comments, java.util.List worklistAssignees) throws PCException, WorklistServiceException
ITaskService.updateTaskOutcomeAndRoute(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, java.lang.String, oracle.bpel.services.workflow.metadata.routingslip.model.Participants)
Performs an adhoc route action on the task with the specified taskId. The conclusion on the task is updated and the task is assigned to the specified list of worklist assignees
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 Servicevoid updateTask(IWorklistContext ctx, IWorklistTask task) throws PCException, WorklistServiceException
ITaskService.updateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs an update action on the task with the specified taskId. This method should be used for only updating the priority, task key or flex fields on the task.
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 ServiceIWorklistTask appendTaskComments(IWorklistContext ctx, java.lang.String taskId, java.lang.String comments) throws PCException, WorklistServiceException
ITaskService.addComment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, java.lang.String)
Appends the comments to the task with the specified taskId.
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 Servicevoid 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
ITaskService.addAttachment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.model.AttachmentType)
Adds an attachment to the task with the specified taskId.
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 Servicevoid 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
ITaskService.addAttachment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.model.AttachmentType)
Adds an attachment to the task with the specified taskId.
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 Servicevoid removeTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String[] names) throws PCException, WorklistServiceException
ITaskService.removeAttachment(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, java.util.List)
Removes one or more attachments from the task with the specified taskId.
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 Servicejava.util.List lookupAssignees(IWorklistContext ctx, java.lang.String assigneeType, java.lang.String userLookupList) throws PCException, WorklistServiceException
SystemAttributesType.getAssigneeUsers()
,SystemAttributesType.getAssigneeGroups()
Returns a list of assignee (ITaskAssignee) objects of the specified type that match the userLookupList pattern.
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 ServiceIWorklistContext getContext(java.lang.String contextKey) throws PCException, WorklistServiceException
ITaskQueryService.getWorkflowContext(java.lang.String)
Returns an existing worklist context if the given contextKey is valid. This method is useful if a partner application wishes to use the worklist service based on the context obtained via prior authentication by another application.
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 Servicevoid destroyContext(IWorklistContext ctx)
ITaskQueryService.destroyWorkflowContext(oracle.bpel.services.workflow.verification.IWorkflowContext)
destroyContext recycles a worklist context not needed anymore.
IWorklistTask getWorklistTaskById(IWorklistContext context, java.lang.String taskId) throws PCException
ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a worklist task based on the specified taskId
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity Service or other internal servicesIWorklistTask getWorklistTaskByNumber(IWorklistContext context, int taskNumber) throws PCException
ITaskQueryService.getTaskDetailsByNumber(oracle.bpel.services.workflow.verification.IWorkflowContext, int)
Returns a worklist task based on the specified task number
context
- a valid worklist contexttaskNumber
- the number of the taskPCException
- any exception thrown by the Identity Service or other internal servicesjava.util.List getWorklistTasks(IWorklistContext context, IPredicate pred, IOrdering ordering, int startRow, int endRow) throws PCException
ITaskQueryService.queryTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.util.List, java.util.List, java.lang.String, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int)
Returns a List of task (IWorklistTask) objects based on the specified IPredicate and IOrdering criterion. A range of tasks from the qualifying result set is retrieved. The startRow specifies the first row in the result set to be retrieved and the lastRow specifies the last row.
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)lastRow
- the row number of the last row in the result set (for paging)PCException
java.util.List getWorklistTasks(IWorklistContext context, IPredicate pred, IOrdering ordering) throws PCException
ITaskQueryService.queryTasks(oracle.bpel.services.workflow.verification.IWorkflowContext, java.util.List, java.util.List, java.lang.String, java.lang.String, oracle.bpel.services.workflow.repos.Predicate, oracle.bpel.services.workflow.repos.Ordering, int, int)
Returns a List of task (IWorklistTask) objects based on the specified IPredicate and IOrdering criterion.
context
- a valid worklist contextpred
- a valid IPredicate object representing the filter criterionordering
- a valid IOrdering object representing the sorting criterionPCException
java.util.List getWorklistHistoryIds(IWorklistContext context, IPredicate pred, int startRow, int endRow) throws PCException
ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a List of task ids from the task history table based on the specified IPredicate criterion. A range of tasks from the qualifying result set is retrieved. The startRow specifies the first row in the result set to be retrieved and the lastRow specifies the last row.
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)lastRow
- the row number of the last row in the result set (for paging)PCException
java.util.List getWorklistHistoryIds(IWorklistContext context, IPredicate pred) throws PCException
ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a List of task ids from the task history table based on the specified IPredicate criterion.
context
- a valid worklist contextpred
- a valid IPredicate object representing the filter criterionPCException
|
Oracle Fusion Middleware Workflow Services Java API Reference for Oracle SOA Suite 11g Release 1 (11.1.1.5.0) E10660-05 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |