|
Oracle Fusion Middleware Workflow Services Java API Reference for Oracle SOA Suite 11g Release 1 (11.1.1.4.0) E10660-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.tip.pc.services.hw.worklist.RemoteWorklistServiceClient
Deprecated. Use IWorkflowServiceClient
, WorkflowServiceClientFactory
which can be used to invoke ITaskService
, ITaskQueryService
and other interfaces in oracle.bpel.services.workflow package
public class RemoteWorklistServiceClient
This class provides a remote API to the WorklistService, allowing clients to access the WorklistService from outside of the J2EE container that hosts the WorklistService. The class provides wrapper methods which invoke methods on the oracle.tip.pc.services.hw.worklist.RemoteWorklistService interface, which is implemented by a stateless session EJB in the J2EE container. When using this class, the init() method must be the first method invoked. This initializes the class to access the RemoteWorklistService EJB. On initialization, the class loads JNDI properties from the file 'hw_worklist_jndi.properites'. This file must be located in your classpath for this class to work. This class provides methods that prodvide similar functionality to the methods provided by the oracle.tip.pc.api.worklist.IWorklistService interface. The RemoteWorklistService interface uses the @link oracle.tip.pc.services.hw.task.impl.Task class to represent worklist tasks, rather than the @link oracle.tip.pc.api.worklist.IWorklistTask used in the local WorklistService API. The Task object provides only a subset of the functionality supported by IWorklistTask, so the RemoteWorklistService interface also provides a number of methods that provide similar functionality to methods provided by IWorklistTask which are not supported by the Task object. Note that the remote worklist API does not fully support task file attachments, due to the problems in using data streams in a remote context. URL attachments are supported. Adding new file attachments is not supported, and reading existing file attachments from a task can have unpredictable results, particularly for binary data. A sample code fragment that uses the remote worklist service is shown below.
// 1. create and initialize a RemoteWorklistServiceClient RemoteWorklistServiceClient client = new RemoteWorklistServiceClient(); client.init(); // 2. get worklist context for current user after authentication String user = "jstein"; String password = "welcome"; IWorklistContext ctx = client.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 = client.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")) { client.appendTaskComments(ctx, taskId, "foo"); // now approve the task String action = "APPROVE"; client.customTaskOperation(ctx, taskId, action); } } }
See the BPELPM Developer's Guide, Chapter 16 for more information on using the RemoteWorklist API.
Field Summary | |
---|---|
static java.lang.String |
EJB_NAME Deprecated. |
static java.lang.String |
JNDI_PROPERTY_FILE Deprecated. |
Constructor Summary | |
---|---|
RemoteWorklistServiceClient() Deprecated. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String JNDI_PROPERTY_FILE
public static java.lang.String EJB_NAME
Constructor Detail |
---|
public RemoteWorklistServiceClient()
Method Detail |
---|
public void init() throws java.rmi.RemoteException, WorklistServiceException
java.rmi.RemoteException
WorklistServiceException
public IWorklistContext createContext(HttpServletRequest request) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskQueryService.authenticate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
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 Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic IWorklistContext authenticateUser(java.lang.String user, java.lang.String password) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public IWorklistGroup getGroupInfo(IWorklistContext ctx, java.lang.String group) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public IWorklistUser getUserInfo(IWorklistContext ctx, java.lang.String user) throws java.rmi.RemoteException, 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.rmi.RemoteException
public java.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) throws java.rmi.RemoteException, 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 (@link Task) 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.rmi.RemoteException
public java.util.List getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder) throws java.rmi.RemoteException, 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 (Task) 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.rmi.RemoteException
public java.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow) throws java.rmi.RemoteException, 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 (Task) 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.rmi.RemoteException
public 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 java.rmi.RemoteException, 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 (Task) 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskDetails(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a task (Task) 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskVersionDetails(IWorklistContext ctx, java.lang.String taskId, int version) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskQueryService.getTaskVersionDetails(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, int)
Returns a task (Task) 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.rmi.RemoteException
public java.util.List getWorklistTaskHistory(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a list of history tasks (Task) 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.rmi.RemoteException
public java.util.List getWorklistTaskBusinessProcesses(IWorklistContext ctx) throws java.rmi.RemoteException, PCException, WorklistServiceException
ctx
- a valid worklist contextPCException
- any exception thrown by the Identity Service or other internal servicesWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task acquireTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task releaseTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task escalateTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task renewTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String durationDays) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task withdrawTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task suspendTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task resumeTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task requestInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task requestInfoForTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String user, boolean reapprovalNeeded, java.lang.String comments) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task submitInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task delegateTask(IWorklistContext ctx, java.lang.String taskId, java.util.List worklistAssignees) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation) throws java.rmi.RemoteException, 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 a custom action (set conclusion) on the task with the specified taskId
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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation, java.lang.String comments) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task completeAndRouteTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String conclusion, java.lang.String comments, java.util.List worklistAssignees) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public oracle.tip.pc.services.hw.task.impl.Task appendTaskComments(IWorklistContext ctx, java.lang.String taskId, java.lang.String comments) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskService.addComment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, java.lang.String)
Appends the specified comments to the comments field of the task with the specified taskId.
ctx
- a valid worklist contexttaskId
- the id of the taskcomments
- new task comments to appendPCException
- 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.rmi.RemoteException
public 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 java.rmi.RemoteException, 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. Note that file attachments are not currently supported, as only serializzable datatypes can be used in the remote API, and InputStream types are not serializable. Use of this method should be restricted to URL attachments only.
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
- [Not currently supported] the dataStream from which to read the contents (needed only for file attachment)boundary
- [Not currently supported] 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 Servicejava.rmi.RemoteException
public 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 java.rmi.RemoteException, 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. Note that file attachments are not currently supported, as only serializzable datatypes can be used in the remote API, and InputStream types are not serializable. Use of this method should be restricted to URL attachments only.
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
- [Not currently supported] the dataStream from which to read the contents (needed only for file attachment)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 Servicejava.rmi.RemoteException
public void removeTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String[] names) throws java.rmi.RemoteException, 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.rmi.RemoteException
public java.util.List lookupAssignees(IWorklistContext ctx, java.lang.String assigneeType, java.lang.String userLookupList) throws java.rmi.RemoteException, PCException, WorklistServiceException
ctx
- a valid worklist contextassigneeType
- the type of assignees to search (one of the ASSIGNEE_TYPE_* constants listed in IWorkflowService)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 Servicejava.rmi.RemoteException
public IWorklistContext getContext(java.lang.String contextKey) throws java.rmi.RemoteException, 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 Servicejava.rmi.RemoteException
public void destroyContext(IWorklistContext ctx) throws java.rmi.RemoteException, WorklistServiceException
ITaskQueryService.destroyWorkflowContext(oracle.bpel.services.workflow.verification.IWorkflowContext)
destroyContext recycles a worklist context not needed anymore.
java.rmi.RemoteException
WorklistServiceException
public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskById(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
Returns a 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 servicesjava.rmi.RemoteException
WorklistServiceException
public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskByNumber(IWorklistContext ctx, int taskNumber) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskQueryService.getTaskDetailsByNumber(oracle.bpel.services.workflow.verification.IWorkflowContext, int)
Returns a 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.rmi.RemoteException
WorklistServiceException
public java.util.List getWorklistTasks(IWorklistContext ctx, IPredicate pred, IOrdering ordering, int startRow, int endRow) throws java.rmi.RemoteException, 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 task (Task) 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.rmi.RemoteException
WorklistServiceException
public java.util.List getWorklistTasks(IWorklistContext ctx, IPredicate pred, IOrdering ordering) throws java.rmi.RemoteException, 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 task (Task) 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.rmi.RemoteException
WorklistServiceException
public java.util.List getWorklistHistoryIds(IWorklistContext ctx, IPredicate pred, int startRow, int endRow) throws java.rmi.RemoteException, PCException, WorklistServiceException
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.rmi.RemoteException
WorklistServiceException
public java.util.List getWorklistHistoryIds(IWorklistContext ctx, IPredicate pred) throws java.rmi.RemoteException, PCException, WorklistServiceException
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
java.rmi.RemoteException
WorklistServiceException
public ITaskAssignee getAssignee(IWorklistContext ctx, java.lang.String taskId, java.lang.String name) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskname
- the name of the assignee (group or user)PCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.List getAssignee(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.Map getConclusionDisplayNames(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
BPMAction.getDisplayName()
Gets a map of display values of all conclusion keys for the specified task.
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.Map getFlexFieldDisplayNames(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
IRuntimeConfigService
Gets a map of display names for all flex fields that have been defined for the task.
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.lang.Object getPayload(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
TaskType.getPayload()
Gets the payload object for the task with the specifeid taskId
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.lang.String getFormattedPayload(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.lang.String getPayloadJsp(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.List getSubTasks(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.Set getUsersToRequestInfoForTask(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskService.getUsersToRequestInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Gets a set of the names of users who could be asked by default to provide more information about the task with the specifeid taskId
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic boolean isAdhocRoutingSupported(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
ParticipantsType.isIsAdhocRoutingSupported()
Checks if adHoc routing is supported for the task with the specified taskId
context
- a valid worklist contexttaskId
- the id of the tasktrue
if adHoc routing supported, otherwise false
PCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic boolean isTaskDetailsErrored(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the tasktrue
if task details errored, otherwise false
PCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic boolean isTaskReapprovalSupported(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the tasktrue
if task re-approval supported, otherwise false
PCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic boolean hasCompleteInformation(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the tasktrue
if infomration is complete, otherwise false
PCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.lang.String getCustomDetailsPage(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.List getCustomActions(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
SystemAttributesType.getCustomActions()
Gets a List of the custom actions (conclusions) for the task with the specifeid taskId
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic java.util.List getSystemActions(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
SystemAttributesType.getSystemActions()
Gets the List of system actions available for the task with the specifeid taskId
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote APIpublic void updateTask(IWorklistContext ctx, oracle.tip.pc.services.hw.task.impl.Task task) throws java.rmi.RemoteException, PCException, WorklistServiceException
ITaskService.updateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
Performs an update action on specified task object. Updates are written to the persistency store, and the task is versioned, if necessary. Note that updates to attachments, task conculsion etc. should be done explicitly, using the provided methods in this class.
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 Servicejava.rmi.RemoteException
public java.lang.String getPayloadEncoding(IWorklistContext ctx, java.lang.String taskId) throws java.rmi.RemoteException, PCException, WorklistServiceException
context
- a valid worklist contexttaskId
- the id of the taskPCException
- any exception thrown by the Identity ServiceWorklistServiceException
- any exception encountered by the Worklist Servicejava.rmi.RemoteException
- any communications-related exception encountered in invoking remote API
|
Oracle Fusion Middleware Workflow Services Java API Reference for Oracle SOA Suite 11g Release 1 (11.1.1.4.0) E10660-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |