Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1)
E10660-03
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.tip.pc.services.hw.worklist
Class RemoteWorklistServiceClient

java.lang.Object
  extended by 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
extends java.lang.Object

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 &lt 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.

Since:
10.1.2

Field Summary
static java.lang.String EJB_NAME
          Deprecated.  
static java.lang.String JNDI_PROPERTY_FILE
          Deprecated.  

 

Constructor Summary
RemoteWorklistServiceClient()
          Deprecated.  

 

Method Summary
 oracle.tip.pc.services.hw.task.impl.Task acquireTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.acquireTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 void addTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String name, java.lang.String value, java.lang.String type, java.io.InputStream dataStream)
          Deprecated. Replaced by ITaskService.addAttachment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.model.AttachmentType)
 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)
          Deprecated. Replaced by ITaskService.addAttachment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.model.AttachmentType)
 oracle.tip.pc.services.hw.task.impl.Task appendTaskComments(IWorklistContext ctx, java.lang.String taskId, java.lang.String comments)
          Deprecated. Replaced by ITaskService.addComment(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, java.lang.String)
 IWorklistContext authenticateUser(java.lang.String user, java.lang.String password)
          Deprecated. Replaced by ITaskQueryService.authenticate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
 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)
          Deprecated. Replaced by 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)
 IWorklistContext createContext(HttpServletRequest request)
          Deprecated. Replaced by ITaskQueryService.authenticate(java.lang.String, java.lang.String, java.lang.String, java.lang.String)
 oracle.tip.pc.services.hw.task.impl.Task customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation)
          Deprecated. Replaced by 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)
 oracle.tip.pc.services.hw.task.impl.Task customTaskOperation(IWorklistContext ctx, java.lang.String taskId, java.lang.String operation, java.lang.String comments)
          Deprecated. Performs a custom action (set conclusion) on the task with the specified taskId
 oracle.tip.pc.services.hw.task.impl.Task delegateTask(IWorklistContext ctx, java.lang.String taskId, java.util.List worklistAssignees)
          Deprecated. Replaced by ITaskService.delegateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, java.util.List)
 void destroyContext(IWorklistContext ctx)
          Deprecated. Replaced by ITaskQueryService.destroyWorkflowContext(oracle.bpel.services.workflow.verification.IWorkflowContext)
 oracle.tip.pc.services.hw.task.impl.Task escalateTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.escalateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 java.util.List getAssignee(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Gets a list of all assignees (as ITaskAssignee objects) for the task with the specified taskId.
 ITaskAssignee getAssignee(IWorklistContext ctx, java.lang.String taskId, java.lang.String name)
          Deprecated. Gets the assignee (ITaskAssignee) object with the specified name for the task with the specified taskId.
 java.util.Map getConclusionDisplayNames(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. See BPMAction.getDisplayName()
 IWorklistContext getContext(java.lang.String contextKey)
          Deprecated. Replaced by ITaskQueryService.getWorkflowContext(java.lang.String)
 java.util.List getCustomActions(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. See SystemAttributesType.getCustomActions()
 java.lang.String getCustomDetailsPage(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Gets the custom details page for the task with the specifeid taskId, if one is defined
 java.util.Map getFlexFieldDisplayNames(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. See IRuntimeConfigService
 java.lang.String getFormattedPayload(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Gets the payload foramtted into a String for the task with the specifeid taskId
 IWorklistGroup getGroupInfo(IWorklistContext ctx, java.lang.String group)
          Deprecated. Gets information about the specificied group.
 java.lang.Object getPayload(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. See TaskType.getPayload()
 java.lang.String getPayloadEncoding(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Gets the payload encoding used for the payload of the task with the specifeid taskId, if a payload encoding is set.
 java.lang.String getPayloadJsp(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Gets the jsp page for the payload of the task with the specifeid taskId
 java.util.List getSubTasks(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Gets the list of sub-tasks (as Task objects) for the task with the specifeid taskId
 java.util.List getSystemActions(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. See SystemAttributesType.getSystemActions()
 IWorklistUser getUserInfo(IWorklistContext ctx, java.lang.String user)
          Deprecated. Gets information about the specificied user.
 java.util.Set getUsersToRequestInfoForTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.getUsersToRequestInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 java.util.List getWorklistHistoryIds(IWorklistContext ctx, IPredicate pred)
          Deprecated. Replaced by ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
 java.util.List getWorklistHistoryIds(IWorklistContext ctx, IPredicate pred, int startRow, int endRow)
          Deprecated. Replaced by ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
 java.util.List getWorklistTaskBusinessProcesses(IWorklistContext ctx)
          Deprecated. Returns a list of business processes deployed in the system
 oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskById(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
 oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskByNumber(IWorklistContext ctx, int taskNumber)
          Deprecated. Replaced by ITaskQueryService.getTaskDetailsByNumber(oracle.bpel.services.workflow.verification.IWorkflowContext, int)
 oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskDetails(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
 java.util.List getWorklistTaskHistory(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)
 java.util.List getWorklistTasks(IWorklistContext ctx, IPredicate pred, IOrdering ordering)
          Deprecated. Replaced by 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)
 java.util.List getWorklistTasks(IWorklistContext ctx, IPredicate pred, IOrdering ordering, int startRow, int endRow)
          Deprecated. Replaced by 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)
 java.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder)
          Deprecated. Replaced by 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)
 java.util.List getWorklistTasks(IWorklistContext ctx, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder, int startRow, int lastRow)
          Deprecated. Replaced by 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)
 java.util.List getWorklistTasks(IWorklistContext ctx, java.lang.String keywords, java.util.Map filterMap, java.lang.String sortField, java.lang.String sortOrder)
          Deprecated. Replaced by 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)
 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)
          Deprecated. Replaced by 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)
 oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskVersionDetails(IWorklistContext ctx, java.lang.String taskId, int version)
          Deprecated. Replaced by ITaskQueryService.getTaskVersionDetails(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, int)
 boolean hasCompleteInformation(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Checks if the task with the specified taskId has complete information (payload etc.)
 void init()
          Deprecated. This method should be the first method called when using the RemoteWorklistClient.
 boolean isAdhocRoutingSupported(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. See ParticipantsType.isIsAdhocRoutingSupported()
 boolean isTaskDetailsErrored(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Checks if there were any errors encountered when constructing task details for the task with the specified taskId
 boolean isTaskReapprovalSupported(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Checks if re-approval is supported for the task with the specified taskId
 java.util.List lookupAssignees(IWorklistContext ctx, java.lang.String assigneeType, java.lang.String userLookupList)
          Deprecated. Returns a list of assignee (ITaskAssignee) objects of the specified type that match the userLookupList pattern.
 oracle.tip.pc.services.hw.task.impl.Task releaseTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.releaseTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 void removeTaskAttachment(IWorklistContext ctx, java.lang.String taskId, java.lang.String[] names)
          Deprecated. Replaced by ITaskService.removeAttachment(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, java.util.List)
 oracle.tip.pc.services.hw.task.impl.Task renewTask(IWorklistContext ctx, java.lang.String taskId, java.lang.String durationDays)
          Deprecated. Replaced by ITaskService.renewTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.impl.Duration)
 oracle.tip.pc.services.hw.task.impl.Task requestInfoForTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.requestInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.ITaskAssignee)
 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)
          Deprecated. Replaced by ITaskService.requestInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task, oracle.bpel.services.workflow.task.ITaskAssignee)
 oracle.tip.pc.services.hw.task.impl.Task resumeTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.resumeTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 oracle.tip.pc.services.hw.task.impl.Task submitInfoForTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.submitInfoForTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 oracle.tip.pc.services.hw.task.impl.Task suspendTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.suspendTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 void updateTask(IWorklistContext ctx, oracle.tip.pc.services.hw.task.impl.Task task)
          Deprecated. Replaced by ITaskService.updateTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)
 oracle.tip.pc.services.hw.task.impl.Task withdrawTask(IWorklistContext ctx, java.lang.String taskId)
          Deprecated. Replaced by ITaskService.withdrawTask(oracle.bpel.services.workflow.verification.IWorkflowContext, oracle.bpel.services.workflow.task.model.Task)

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

JNDI_PROPERTY_FILE

public static java.lang.String JNDI_PROPERTY_FILE
Deprecated. 

EJB_NAME

public static java.lang.String EJB_NAME
Deprecated. 

Constructor Detail

RemoteWorklistServiceClient

public RemoteWorklistServiceClient()
Deprecated. 

Method Detail

init

public void init()
          throws java.rmi.RemoteException,
                 WorklistServiceException
Deprecated. 
This method should be the first method called when using the RemoteWorklistClient. The method expects a file named "hw_worklist_jndi.properties" to be present in the classpath. This file should contain the JNDI properties required to connect to the remote J2EE container.
Throws:
java.rmi.RemoteException
WorklistServiceException

createContext

public IWorklistContext createContext(HttpServletRequest request)
                               throws java.rmi.RemoteException,
                                      PCException,
                                      WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
request - the servletRequest containing the remote user information
Returns:
a new worklist context
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

authenticateUser

public IWorklistContext authenticateUser(java.lang.String user,
                                         java.lang.String password)
                                  throws java.rmi.RemoteException,
                                         PCException,
                                         WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
user - the name of the user
password - the password for the specified user
Returns:
a new worklist context
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getGroupInfo

public IWorklistGroup getGroupInfo(IWorklistContext ctx,
                                   java.lang.String group)
                            throws java.rmi.RemoteException,
                                   PCException,
                                   WorklistServiceException
Deprecated. 
Gets information about the specificied group.
Parameters:
ctx - a valid worklist context
group - the name of the group for which info is needed
Returns:
a worklist group object
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getUserInfo

public IWorklistUser getUserInfo(IWorklistContext ctx,
                                 java.lang.String user)
                          throws java.rmi.RemoteException,
                                 PCException,
                                 WorklistServiceException
Deprecated. 
Gets information about the specificied user.
Parameters:
ctx - a valid worklist context
user - the name of the user for which info is needed
Returns:
a worklist user object
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTasks

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
filterMap - a map specifying the filter types and their values
sortField - the task field to be used for sorting the tasks
sortOrder - the sort order to be used for sorting the tasks
Returns:
a list of qualifying task objects
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTasks

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
keywords - search string to be used while filtering
filterMap - a map specifying the filter types and their values
sortField - the task field to be used for sorting the tasks
sortOrder - the sort order to be used for sorting the tasks
Returns:
a list of qualifying task objects
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTasks

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
filterMap - a map specifying the filter types and their values
sortField - the task field to be used for sorting the tasks
sortOrder - the sort order to be used for sorting the tasks
startRow - 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)
Returns:
a list of qualifying task objects
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTasks

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
keywords - search string to be used while filtering
filterMap - a map specifying the filter types and their values
sortField - the task field to be used for sorting the tasks
sortOrder - the sort order to be used for sorting the tasks
startRow - 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)
Returns:
a list of qualifying task objects
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTaskDetails

public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskDetails(IWorklistContext ctx,
                                                                       java.lang.String taskId)
                                                                throws java.rmi.RemoteException,
                                                                       PCException,
                                                                       WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object with all details
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTaskVersionDetails

public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskVersionDetails(IWorklistContext ctx,
                                                                              java.lang.String taskId,
                                                                              int version)
                                                                       throws java.rmi.RemoteException,
                                                                              PCException,
                                                                              WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
version - the version number of the task
Returns:
a task object with all details
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTaskHistory

public java.util.List getWorklistTaskHistory(IWorklistContext ctx,
                                             java.lang.String taskId)
                                      throws java.rmi.RemoteException,
                                             PCException,
                                             WorklistServiceException
Deprecated. 
Replaced by ITaskQueryService.getTaskHistory(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)

Returns a list of history tasks (Task) based on the specified taskId

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a list of qualifying task objects
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

getWorklistTaskBusinessProcesses

public java.util.List getWorklistTaskBusinessProcesses(IWorklistContext ctx)
                                                throws java.rmi.RemoteException,
                                                       PCException,
                                                       WorklistServiceException
Deprecated. 
Returns a list of business processes deployed in the system
Parameters:
ctx - a valid worklist context
Returns:
a list (of String objects) containing business processes names
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException

acquireTask

public oracle.tip.pc.services.hw.task.impl.Task acquireTask(IWorklistContext ctx,
                                                            java.lang.String taskId)
                                                     throws java.rmi.RemoteException,
                                                            PCException,
                                                            WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

releaseTask

public oracle.tip.pc.services.hw.task.impl.Task releaseTask(IWorklistContext ctx,
                                                            java.lang.String taskId)
                                                     throws java.rmi.RemoteException,
                                                            PCException,
                                                            WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

escalateTask

public oracle.tip.pc.services.hw.task.impl.Task escalateTask(IWorklistContext ctx,
                                                             java.lang.String taskId)
                                                      throws java.rmi.RemoteException,
                                                             PCException,
                                                             WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

renewTask

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
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
durationDays - the renew duration for the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

withdrawTask

public oracle.tip.pc.services.hw.task.impl.Task withdrawTask(IWorklistContext ctx,
                                                             java.lang.String taskId)
                                                      throws java.rmi.RemoteException,
                                                             PCException,
                                                             WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

suspendTask

public oracle.tip.pc.services.hw.task.impl.Task suspendTask(IWorklistContext ctx,
                                                            java.lang.String taskId)
                                                     throws java.rmi.RemoteException,
                                                            PCException,
                                                            WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

resumeTask

public oracle.tip.pc.services.hw.task.impl.Task resumeTask(IWorklistContext ctx,
                                                           java.lang.String taskId)
                                                    throws java.rmi.RemoteException,
                                                           PCException,
                                                           WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

requestInfoForTask

public oracle.tip.pc.services.hw.task.impl.Task requestInfoForTask(IWorklistContext ctx,
                                                                   java.lang.String taskId)
                                                            throws java.rmi.RemoteException,
                                                                   PCException,
                                                                   WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

requestInfoForTask

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
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
user - the user from whom to request more information
reapprovalNeeded - flag indicating if repproval is needed in the approval chain
comments - task comments if any for this action
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

submitInfoForTask

public oracle.tip.pc.services.hw.task.impl.Task submitInfoForTask(IWorklistContext ctx,
                                                                  java.lang.String taskId)
                                                           throws java.rmi.RemoteException,
                                                                  PCException,
                                                                  WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

delegateTask

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
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
worklistAssignees - a list of ITaskAssignee objects (chosen using identity lookup)
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

customTaskOperation

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
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
operation - the name of the custom action (should be a valid conclusion)
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

customTaskOperation

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
Deprecated. 
Performs a custom action (set conclusion) on the task with the specified taskId
Parameters:
ctx - a valid worklist context
taskId - the id of the task
operation - the name of the custom action (should be a valid conclusion)
comments - task comments if any for this action
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

completeAndRouteTask

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
Deprecated. 
Replaced by 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

Parameters:
ctx - a valid worklist context
taskId - the id of the task
conclusion - the name of the conclusion
comments - task comments if any for this action
worklistAssignees - a list of ITaskAssignee objects (chosen using identity lookup)
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

appendTaskComments

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
taskId - the id of the task
comments - new task comments to append
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

addTaskAttachment

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
taskId - the id of the task
name - the name of the task attachment
value - 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 dataStream
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

addTaskAttachment

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
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
taskId - the id of the task
name - the name of the task attachment
value - 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)
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

removeTaskAttachment

public void removeTaskAttachment(IWorklistContext ctx,
                                 java.lang.String taskId,
                                 java.lang.String[] names)
                          throws java.rmi.RemoteException,
                                 PCException,
                                 WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
taskId - the id of the task
names - a string array of attachment names to be removed
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

lookupAssignees

public java.util.List lookupAssignees(IWorklistContext ctx,
                                      java.lang.String assigneeType,
                                      java.lang.String userLookupList)
                               throws java.rmi.RemoteException,
                                      PCException,
                                      WorklistServiceException
Deprecated. 
Returns a list of assignee (ITaskAssignee) objects of the specified type that match the userLookupList pattern.
Parameters:
ctx - a valid worklist context
assigneeType - the type of assignees to search (one of the ASSIGNEE_TYPE_* constants listed in IWorkflowService)
userLookupList - a string pattern for lookup
Returns:
a list of assignee (ITaskAssignee) objects
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

getContext

public IWorklistContext getContext(java.lang.String contextKey)
                            throws java.rmi.RemoteException,
                                   PCException,
                                   WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
contextKey - a valid worklist context key
Returns:
an existing worklist context that matches the specified key
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

destroyContext

public void destroyContext(IWorklistContext ctx)
                    throws java.rmi.RemoteException,
                           WorklistServiceException
Deprecated. 
Replaced by ITaskQueryService.destroyWorkflowContext(oracle.bpel.services.workflow.verification.IWorkflowContext)

destroyContext recycles a worklist context not needed anymore.

Throws:
java.rmi.RemoteException
WorklistServiceException

getWorklistTaskById

public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskById(IWorklistContext ctx,
                                                                    java.lang.String taskId)
                                                             throws java.rmi.RemoteException,
                                                                    PCException,
                                                                    WorklistServiceException
Deprecated. 
Replaced by ITaskQueryService.getTaskDetailsById(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String)

Returns a task based on the specified taskId

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
java.rmi.RemoteException
WorklistServiceException

getWorklistTaskByNumber

public oracle.tip.pc.services.hw.task.impl.Task getWorklistTaskByNumber(IWorklistContext ctx,
                                                                        int taskNumber)
                                                                 throws java.rmi.RemoteException,
                                                                        PCException,
                                                                        WorklistServiceException
Deprecated. 
Replaced by ITaskQueryService.getTaskDetailsByNumber(oracle.bpel.services.workflow.verification.IWorkflowContext, int)

Returns a task based on the specified task number

Parameters:
context - a valid worklist context
taskNumber - the number of the task
Returns:
a task object
Throws:
PCException - any exception thrown by the Identity Service or other internal services
java.rmi.RemoteException
WorklistServiceException

getWorklistTasks

public java.util.List getWorklistTasks(IWorklistContext ctx,
                                       IPredicate pred,
                                       IOrdering ordering,
                                       int startRow,
                                       int endRow)
                                throws java.rmi.RemoteException,
                                       PCException,
                                       WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
context - a valid worklist context
pred - a valid IPredicate object representing the filter criterion
ordering - a valid IOrdering object representing the sorting criterion
startRow - 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)
Returns:
a list of qualifying task objects
Throws:
PCException
java.rmi.RemoteException
WorklistServiceException

getWorklistTasks

public java.util.List getWorklistTasks(IWorklistContext ctx,
                                       IPredicate pred,
                                       IOrdering ordering)
                                throws java.rmi.RemoteException,
                                       PCException,
                                       WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
context - a valid worklist context
pred - a valid IPredicate object representing the filter criterion
ordering - a valid IOrdering object representing the sorting criterion
Returns:
a list of qualifying task objects
Throws:
PCException
java.rmi.RemoteException
WorklistServiceException

getWorklistHistoryIds

public java.util.List getWorklistHistoryIds(IWorklistContext ctx,
                                            IPredicate pred,
                                            int startRow,
                                            int endRow)
                                     throws java.rmi.RemoteException,
                                            PCException,
                                            WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
context - a valid worklist context
pred - a valid IPredicate object representing the filter criterion
startRow - 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)
Returns:
a list of qualifying task IDs from the tasks history
Throws:
PCException
java.rmi.RemoteException
WorklistServiceException

getWorklistHistoryIds

public java.util.List getWorklistHistoryIds(IWorklistContext ctx,
                                            IPredicate pred)
                                     throws java.rmi.RemoteException,
                                            PCException,
                                            WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
context - a valid worklist context
pred - a valid IPredicate object representing the filter criterion
Returns:
a list of qualifying task IDs from the tasks history
Throws:
PCException
java.rmi.RemoteException
WorklistServiceException

getAssignee

public ITaskAssignee getAssignee(IWorklistContext ctx,
                                 java.lang.String taskId,
                                 java.lang.String name)
                          throws java.rmi.RemoteException,
                                 PCException,
                                 WorklistServiceException
Deprecated. 
Gets the assignee (ITaskAssignee) object with the specified name for the task with the specified taskId.
Parameters:
context - a valid worklist context
taskId - the id of the task
name - the name of the assignee (group or user)
Returns:
the assignee (as an ITaskAssignee object)
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getAssignee

public java.util.List getAssignee(IWorklistContext ctx,
                                  java.lang.String taskId)
                           throws java.rmi.RemoteException,
                                  PCException,
                                  WorklistServiceException
Deprecated. 
Gets a list of all assignees (as ITaskAssignee objects) for the task with the specified taskId.
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
a list of ITaskAssignee objects
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getConclusionDisplayNames

public java.util.Map getConclusionDisplayNames(IWorklistContext ctx,
                                               java.lang.String taskId)
                                        throws java.rmi.RemoteException,
                                               PCException,
                                               WorklistServiceException
Deprecated. 
See BPMAction.getDisplayName()

Gets a map of display values of all conclusion keys for the specified task.

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
a map of display values of all conclusion keys
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getFlexFieldDisplayNames

public java.util.Map getFlexFieldDisplayNames(IWorklistContext ctx,
                                              java.lang.String taskId)
                                       throws java.rmi.RemoteException,
                                              PCException,
                                              WorklistServiceException
Deprecated. 
See IRuntimeConfigService

Gets a map of display names for all flex fields that have been defined for the task.

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
a map of display names for defined flex-fields. Returns an empty map if not flex-fields have been defined.
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getPayload

public java.lang.Object getPayload(IWorklistContext ctx,
                                   java.lang.String taskId)
                            throws java.rmi.RemoteException,
                                   PCException,
                                   WorklistServiceException
Deprecated. 
See TaskType.getPayload()

Gets the payload object for the task with the specifeid taskId

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the payload object
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getFormattedPayload

public java.lang.String getFormattedPayload(IWorklistContext ctx,
                                            java.lang.String taskId)
                                     throws java.rmi.RemoteException,
                                            PCException,
                                            WorklistServiceException
Deprecated. 
Gets the payload foramtted into a String for the task with the specifeid taskId
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the payload formatted as a String
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getPayloadJsp

public java.lang.String getPayloadJsp(IWorklistContext ctx,
                                      java.lang.String taskId)
                               throws java.rmi.RemoteException,
                                      PCException,
                                      WorklistServiceException
Deprecated. 
Gets the jsp page for the payload of the task with the specifeid taskId
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the payload jsp as a String
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getSubTasks

public java.util.List getSubTasks(IWorklistContext ctx,
                                  java.lang.String taskId)
                           throws java.rmi.RemoteException,
                                  PCException,
                                  WorklistServiceException
Deprecated. 
Gets the list of sub-tasks (as Task objects) for the task with the specifeid taskId
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
a List of Task objects
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getUsersToRequestInfoForTask

public java.util.Set getUsersToRequestInfoForTask(IWorklistContext ctx,
                                                  java.lang.String taskId)
                                           throws java.rmi.RemoteException,
                                                  PCException,
                                                  WorklistServiceException
Deprecated. 
Replaced by 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

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
set of usernames
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

isAdhocRoutingSupported

public boolean isAdhocRoutingSupported(IWorklistContext ctx,
                                       java.lang.String taskId)
                                throws java.rmi.RemoteException,
                                       PCException,
                                       WorklistServiceException
Deprecated. 
See ParticipantsType.isIsAdhocRoutingSupported()

Checks if adHoc routing is supported for the task with the specified taskId

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
true if adHoc routing supported, otherwise false
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

isTaskDetailsErrored

public boolean isTaskDetailsErrored(IWorklistContext ctx,
                                    java.lang.String taskId)
                             throws java.rmi.RemoteException,
                                    PCException,
                                    WorklistServiceException
Deprecated. 
Checks if there were any errors encountered when constructing task details for the task with the specified taskId
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
true if task details errored, otherwise false
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

isTaskReapprovalSupported

public boolean isTaskReapprovalSupported(IWorklistContext ctx,
                                         java.lang.String taskId)
                                  throws java.rmi.RemoteException,
                                         PCException,
                                         WorklistServiceException
Deprecated. 
Checks if re-approval is supported for the task with the specified taskId
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
true if task re-approval supported, otherwise false
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

hasCompleteInformation

public boolean hasCompleteInformation(IWorklistContext ctx,
                                      java.lang.String taskId)
                               throws java.rmi.RemoteException,
                                      PCException,
                                      WorklistServiceException
Deprecated. 
Checks if the task with the specified taskId has complete information (payload etc.)
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
true if infomration is complete, otherwise false
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getCustomDetailsPage

public java.lang.String getCustomDetailsPage(IWorklistContext ctx,
                                             java.lang.String taskId)
                                      throws java.rmi.RemoteException,
                                             PCException,
                                             WorklistServiceException
Deprecated. 
Gets the custom details page for the task with the specifeid taskId, if one is defined
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the custom details page, null if none is defined
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getCustomActions

public java.util.List getCustomActions(IWorklistContext ctx,
                                       java.lang.String taskId)
                                throws java.rmi.RemoteException,
                                       PCException,
                                       WorklistServiceException
Deprecated. 
See SystemAttributesType.getCustomActions()

Gets a List of the custom actions (conclusions) for the task with the specifeid taskId

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the List of custom actions
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

getSystemActions

public java.util.List getSystemActions(IWorklistContext ctx,
                                       java.lang.String taskId)
                                throws java.rmi.RemoteException,
                                       PCException,
                                       WorklistServiceException
Deprecated. 
See SystemAttributesType.getSystemActions()

Gets the List of system actions available for the task with the specifeid taskId

Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the List of system actions
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

updateTask

public void updateTask(IWorklistContext ctx,
                       oracle.tip.pc.services.hw.task.impl.Task task)
                throws java.rmi.RemoteException,
                       PCException,
                       WorklistServiceException
Deprecated. 
Replaced by 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.

Parameters:
ctx - a valid worklist context
taskId - the id of the task
Throws:
PCException - any exception thrown by the Identity Service or other internal services
WorklistServiceException - if user does not have permission to perform this action or if any exception is encountered by the Worklist Service
java.rmi.RemoteException

getPayloadEncoding

public java.lang.String getPayloadEncoding(IWorklistContext ctx,
                                           java.lang.String taskId)
                                    throws java.rmi.RemoteException,
                                           PCException,
                                           WorklistServiceException
Deprecated. 
Gets the payload encoding used for the payload of the task with the specifeid taskId, if a payload encoding is set.
Parameters:
context - a valid worklist context
taskId - the id of the task
Returns:
the payload encoding, or null if payload encoding has not been set.
Throws:
PCException - any exception thrown by the Identity Service
WorklistServiceException - any exception encountered by the Worklist Service
java.rmi.RemoteException - any communications-related exception encountered in invoking remote API

Skip navigation links

Overview  Package   Class  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware
Workflow Services Java API Reference for Oracle SOA Suite
11g Release 1 (11.1.1)
E10660-03
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2009, Oracle and/or its affiliates. All rights reserved.