Package oracle.bpel.services.workflow.query

Interface ITaskQueryService

public interface ITaskQueryService
 This class provides a programmatic means for retrieving tasks, task details, etc
 
 A typical usage would be as follows:
  1. Use an authentication method to authenticate a user and obtain a context
  2. Use the context and a task list method to retrieve tasks that match some filter criterion
  3. Use the context and a task details method to drill down on a task in the list (retrieve task details
        and actions that can be performed on the task)
  4. Use task service, to perform operations on the task
  
 A sample code fragment that shows the usage in the above pattern in shown below:
 
   import java.util.ArrayList;
   import java.util.Date;
   import java.util.List;    
   import oracle.bpel.services.workflow.IWorkflowConstants;
   import oracle.bpel.services.workflow.client.IWorkflowServiceClient;
   import oracle.bpel.services.workflow.client.IWorkflowServiceClientConstants;
   import oracle.bpel.services.workflow.client.WorkflowServiceClientFactory;
   import oracle.bpel.services.workflow.query.ITaskQueryService;
   import oracle.bpel.services.workflow.repos.Ordering;
   import oracle.bpel.services.workflow.repos.Predicate;
   import oracle.bpel.services.workflow.repos.TableConstants;
   import oracle.bpel.services.workflow.task.ITaskService;
   import oracle.bpel.services.workflow.task.model.Task;
   import oracle.bpel.services.workflow.verification.IWorkflowContext;      
   
   //User whose task list needs to be queried
   String userId = "jstein";
   // Password for the user
   String password = "welcome1";
   
   // You can use keyword to specify sql % around the keyword like: %keyword% on the following
   // attributes: task title, identification key, all textAttributes in task, task number (only
   // if the keyword is a number)
   
   String keyword = null;
   String nullParam = null;
 
   // Get workflow service client
   IWorkflowServiceClient wfSvcClient = WorkflowServiceClientFactory.getWorkflowServiceClient(WorkflowServiceClientFactory.SOAP_CLIENT);
   // Get the workflow context
   IWorkflowContext wfCtx = wfSvcClient.getTaskQueryService().authenticate(userId, password, 
                                 oracle.tip.pc.services.identity.config.ISConfiguration.getDefaultRealmName(),
                                 null);
   // Admin can authenticate on behalf of another user
   //IWorkflowContext adminCtx = wfSvcClient.getTaskQueryService().authenticate(adminUserId, pwd, 
   //                              oracle.tip.pc.services.identity.config.ISConfiguration.getDefaultRealmName(),
   //                              userId);
   
   ITaskQueryService querySvc = wfSvcClient.getTaskQueryService();      
   
   // Only for SOAP clients and it is mandatory for SOAP clients
   Predicate.enableXMLSerialization(true);
   
   // Build the predicate
   Predicate statePredicate = new Predicate(TableConstants.WFTASK_STATE_COLUMN,
                                Predicate.OP_NEQ,
                                IWorkflowConstants.TASK_STATE_ASSIGNED);
        statePredicate.addClause(Predicate.AND,
                         TableConstants.WFTASK_NUMBERATTRIBUTE1_COLUMN,
                         Predicate.OP_IS_NULL,
                         nullParam);
   Predicate datePredicate = new Predicate(TableConstants.WFTASK_ENDDATE_COLUMN,
                                Predicate.OP_ON,
                                new Date());
   Predicate predicate = new Predicate(statePredicate, Predicate.AND, datePredicate);
   
   // Create the ordering
   Ordering ordering = new Ordering(TableConstants.WFTASK_TITLE_COLUMN, true, true);        
     ordering.addClause(TableConstants.WFTASK_PRIORITY_COLUMN, true, true);
     
   // List of display columns
   // For those columns that are not specified here, the queried Task object will not hold any value.
   // For example: If TITLE is not specified, task.getTitle() will return null
   // For the list of most comonly used columns, check the table below
   // Note: TASKID is fetched by default. So there is no need to explicitly specity it.
   List queryColumns = new ArrayList();
     queryColumns.add("TASKNUMBER");     
     queryColumns.add("TITLE");
     queryColumns.add("PRIORITY");
     queryColumns.add("STATE");
     queryColumns.add("ENDDATE");
     queryColumns.add("NUMBERATTRIBUTE1");
     queryColumns.add("TEXTATTRIBUTE1");
     
   // List of optional info
   // Any optionalInfo specified can be fetched from the Task object
   // For example: if you have specified "CustomActions", you can retrieve
   // it using task.getSystemAttributes().getCustomActions();
   // "Actions" (All Actions) - task.getSystemAttributes().getSystemActions()
   // "GroupActions" (Only group Actions: Actions that can be permoded by the user as a member of a group)
   //                - task.getSystemAttributes().getSystemActions()
   // "ShortHistory" - task.getSystemAttributes().getShortHistory()
   List optionalInfo = new ArrayList();
     optionalInfo.add("Actions");
     //optionalInfo.add("GroupActions");
     //optionalInfo.add("CustomActions");
     //optionalInfo.add("ShortHistory");
     // The following is reserved for future use. 
     // If you need them, please use getTaskDetailsById (or) getTaskDetailsByNumber,
     // which will fetch all information related to a task, which includes these
        //optionalInfo.add("Attachments");
        //optionalInfo.add("Comments");
        //optionalInfo.add("Payload");

   List tasksList = querySvc.queryTasks(wfCtx,
                               queryColumns,
                               optionalInfo,
                               ITaskQueryService.ASSIGNMENT_FILTER_MY_AND_GROUP,
                               keyword,
                               predicate, 
                               ordering, 
                               0,0); // No Paging
                               
   // How to use paging:
   // 1. If you need to dynamically calculate paging size (or) to display/find 
   //    out the number of pages, the user has to scroll (Like page X of Y)
   //      Call countTasks to find out the number of tasks it returns. Using this 
   //      calculate your paging size (The number of taks you want in a page)
   //      Call queryTasks successively varing the startRow and endRow params.  
   //      For example: If the total number of tasks is 30 and your want a paging size
   //      of 10, you can call with (startRow, endRow): (1, 10) (11, 20) (21, 30) 
   // 2. If you have fixed paging size, just keep calling queryTasks successively with 
   //      the paging size (If your paging size is 10, you can call with (startRow, endRow): 
   //      (1, 10) (11, 20) (21, 30) (31, 40).....  until the number of tasks returned is 
   //      less than your paging size (or) there are no more tasks returned.
   // 3. If no paging is specified (startRow and endRow are both zero), then the
   //       first 200 rows will be returned. If for some reason, you require more
   //       than 200 rows, you should explicilty specify a larger paging size.

   if (tasksList != null) { // There are tasks 
     System.out.println("Total number of tasks: " + tasksList.size()); 
     System.out.println("Tasks List: ");
     Task task = null; 
     for (int i = 0; i < tasksList.size(); i++) { 
       task = (Task) tasksList.get(i);          
       System.out.println("Task Number: " + task.getSystemAttributes().getTaskNumber());
       System.out.println("Task Id: " + task.getSystemAttributes().getTaskId());
       System.out.println("Title: " + task.getTitle());
       System.out.println("Priority: " + task.getPriority());
       System.out.println("State: " + task.getSystemAttributes().getState());
       System.out.println();
       // Retrive any Optional Info specified
       // Use task service, to perform operations on the task
     }
   }
   
 Beyond authentication, all methods require the worklist context as the first argument. The worklist context 
 helps the worklist service determine the user requesting the action, whether the user has permission to 
 perform the requested action on the task and so forth. The context also contains information about the 
 user's locale and timezone information.
Most commonly used columns
Column objects are defined in oracle.bpel.services.workflow.repos.TableConstants, and they can also be obtained by passing the column name to the static method getColumn() on oracle.bpel.services.workflow.repos.Column.
A list task attributes and column names can be obtained by calling the method ITaskMetadataService.getTaskAttributes(oracle.bpel.services.workflow.verification.IWorkflowContext) or ITaskMetadataService.getTaskAttributesForTaskDefinition(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String).
Column Description Column Object How to retrieve
ACQUIREDBY Acquired By WFTASK_ACQUIREDBY_COLUMN task.getSystemAttributes().getAcquiredBy()
ASSIGNEES Assignees WFTASK_ASSIGNEES_COLUMN task.getSystemAttributes().getAssignees()
REVIEWERS Reviewers WFTASK_REVIEWERS_COLUMN task.getSystemAttributes().getReviewers()
ASSIGNEEGROUPS Assignee Groups WFTASK_ASSIGNEEGROUPS_COLUMN task.getSystemAttributes().getAssigneeGroups()
ASSIGNEEUSERS Assignee Users WFTASK_ASSIGNEEUSERS_COLUMN task.getSystemAttributes().getAssigneeUsers()
CREATOR Creator WFTASK_CREATOR_COLUMN task.getCreator()
DIGITALSIGNATUREREQUIRED Digital Signature Required WFTASK_DIGITALSIGNATUREREQUIRED_COLUMN task.getSystemAttributes().isDigitalSignatureRequired()
EXPIRATIONDATE Expiration Date WFTASK_EXPIRATIONDATE_COLUMN task.getSystemAttributes().getExpirationDate()
IDENTITYCONTEXT Identity Context WFTASK_IDENTITYCONTEXT_COLUMN task.getIdentityContext()
OWNERUSER Owner User WFTASK_OWNERUSER_COLUMN task.getOwnerUser()
OWNERGROUP Owner Group WFTASK_OWNERGROUP_COLUMN task.getOwnerGroup()
PASSWORDREQUIREDONUPDATE Password Required On Update WFTASK_PASSWORDREQUIREDONUPDATE_COLUMN task.getSystemAttributes().isPasswordRequiredOnUpdate()
PRIORITY Priority WFTASK_PRIORITY_COLUMN task.getPriority()
SECURENOTIFICATIONS Secure Notifications WFTASK_SECURENOTIFICATIONS_COLUMN task.getSystemAttributes().isSecureNotifications()
ASSIGNEDDATE Assigned Date WFTASK_ASSIGNEDDATE_COLUMN task.getSystemAttributes().getAssignedDate()
CREATEDDATE Created Date WFTASK_CREATEDDATE_COLUMN task.getSystemAttributes().getCreatedDate()
ENDDATE End Date WFTASK_ENDDATE_COLUMN task.getSystemAttributes().getEndDate()
FROMUSER From User WFTASK_FROMUSER_COLUMN task.getSystemAttributes().getFromUser()
HASSUBTASK Has Subtask WFTASK_HASSUBTASK_COLUMN task.getSystemAttributes().isHasSubTasks()
ISGROUP Is Group WFTASK_ISGROUP_COLUMN task.getSystemAttributes().isIsGroup()
ORIGINALASSIGNEEUSER Original Assignee User WFTASK_ORIGINALASSIGNEEUSER_COLUMN task.getSystemAttributes().()
OUTCOME Outcome WFTASK_OUTCOME_COLUMN task.getSystemAttributes().getOriginalAssigneeUser()
STATE State WFTASK_STATE_COLUMN task.getSystemAttributes().getState()
TASKID Task Id WFTASK_TASKID_COLUMN task.getSystemAttributes().getTaskId()
TASKNUMBER Task Number WFTASK_TASKNUMBER_COLUMN task.getSystemAttributes().getTaskNumber()
UPDATEDBY Updated By WFTASK_UPDATEDBY_COLUMN task.getSystemAttributes().getUpdatedBy()
UPDATEDDATE Updated Date WFTASK_UPDATEDDATE_COLUMN task.getSystemAttributes().getUpdatedDate()
TEXTATTRIBUTE1 to TEXTATTRIBUTE10 Textattribute1 to Textattribute10 WFTASK_TEXTATTRIBUTE1_COLUMN to WFTASK_TEXTATTRIBUTE10_COLUMN task.getSystemMessageAttributes().getTextAttribute1() to task.getSystemMessageAttributes().getTextAttribute10()
FORMATTRIBUTE1 to FORMATTRIBUTE5 FormAttribute1 to FormAttribute5 WFTASK_FORMATTRIBUTE1_COLUMN to WFTASK_FORMATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getFormAttribute1() to task.getSystemMessageAttributes().getFormAttribute5()
URLATTRIBUTE1 to URLATTRIBUTE5 UrlAttribute1 to UrlAttribute5 WFTASK_URLATTRIBUTE1_COLUMN to WFTASK_URLATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getUrlAttribute1() to task.getSystemMessageAttributes().getUrlAttribute5()
DATEATTRIBUTE1 to DATEATTRIBUTE5 DateAttribute1 to DateAttribute5 WFTASK_DATEATTRIBUTE1_COLUMN to WFTASK_DATEATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getDateAttribute1() to task.getSystemMessageAttributes().getDateAttribute5()
NUMBERATTRIBUTE1 to NUMBERATTRIBUTE5 NumberAttribute1 to NumberAttribute5 WFTASK_NUMBERATTRIBUTE1_COLUMN to WFTASK_NUMBERATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getNumberAttribute1() to task.getSystemMessageAttributes().getNumberAttribute5()
TITLE Title WFTASK_TITLE_COLUMN task.getTitle()
IDENTIFICATIONKEY Identification key WFTASK_IDENTIFICATIONKEY_COLUMN task.getIdentificationKey()
TASKDEFINITIONID Task Definition Id WFTASK_TASKDEFINITIONID_COLUMN task.getTaskDefinitionId()
TASKDEFINITIONNAME Task Definition Name WFTASK_TASKDEFINITIONNAME_COLUMN task.getSystemAttributes().getTaskDefinitionName()
PROTECTEDTEXTATTRIBUTE1 to PROTECTEDTEXTATTRIBUTE10 ProtectedTextAttribute1 to ProtectedTextAttribute10 WFTASK_PROTECTEDTEXTATTRIBUTE1_COLUMN to WFTASK_PROTECTEDTEXTATTRIBUTE10_COLUMN task.getSystemMessageAttributes().getProtectedTextAttribute1() to task.getSystemMessageAttributes().getProtectedTextAttribute10()
PROTECTEDFORMATTRIBUTE1 to PROTECTEDFORMATTRIBUTE5 ProtectedFormAttribute1 to ProtectedFormAttribute5 WFTASK_PROTECTEDFORMATTRIBUTE1_COLUMN to WFTASK_PROTECTEDFORMATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getFormAttribute1() to task.getSystemMessageAttributes().getFormAttribute5()
PROTECTEDURLATTRIBUTE1 to PROTECTEDURLATTRIBUTE5 ProtectedURLAttribute1 to ProtectedURLAttribute5 WFTASK_PROTECTEDURLATTRIBUTE1_COLUMN to WFTASK_PROTECTEDURLATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getProtectedURLAttribute1() to task.getSystemMessageAttributes().getProtectedURLAttribute5()
PROTECTEDDATEATTRIBUTE1 to PROTECTEDDATEATTRIBUTE5 ProtectedDateAttribute1 to ProtectedDateAttribute5 WFTASK_PROTECTEDDATEATTRIBUTE1_COLUMN to WFTASK_PROTECTEDDATEATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getProtectedDateAttribute1() to task.getSystemMessageAttributes().getProtectedDateAttribute5()
PROTECTEDNUMBERATTRIBUTE1 to PROTECTEDNUMBERATTRIBUTE5 ProtectedNumberAttribute1 to ProtectedNumberAttribute5 WFTASK_PROTECTEDNUMBERATTRIBUTE1_COLUMN to WFTASK_PROTECTEDNUMBERATTRIBUTE5_COLUMN task.getSystemMessageAttributes().getProtectedNumberAttribute1() to task.getSystemMessageAttributes().getProtectedNumberAttribute5()
APPLICATIONCONTEXT Application Context WFTASK_APPLICATIONCONTEXT_COLUMN task.getApplicationContext()
CATEGORY Category WFTASK_CATEGORY_COLUMN task.getCategory()
DUEDATE Due Date WFTASK_DUEDATE_COLUMN task.getDueDate()
ISPUBLIC Is Public WFTASK_ISPUBLIC_COLUMN task.isIsPublic()
PARTICIPANTNAME Participant Name WFTASK_PARTICIPANTNAME_COLUMN task.getSystemAttributes().getParticipantName()
PERCENTAGECOMPLETE Percentage Complete WFTASK_PERCENTAGECOMPLETE_COLUMN task.getPercentageComplete()
STARTDATE Start Date WFTASK_STARTDATE_COLUMN task.getStartDate()
TASKDISPLAYURL Task Display Url WFTASK_TASKDISPLAYURL_COLUMN task.getTaskDisplayUrl()

  • Field Details

  • Method Details

    • createContext

      IWorkflowContext createContext(javax.servlet.http.HttpServletRequest request) throws WorkflowException
      createContext is used for creating a context from a pre-authenticated environment such as a SSO based application. The user information is extracted from the authenticated environment and a workflow context is returned for that user (Assuming that HttpServletRequest is from an authenticated user, HttpServletRequest.getRemoteUser() should return the name of the user)

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Parameters:
      request - The pre-authenticated environment (request) to create the context for
      Returns:
      IWorkflowContext the workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • createContextFromRequestObject

      IWorkflowContext createContextFromRequestObject(Object request) throws WorkflowException
      createContextFromRequestObject is used for creating a context from a pre-authenticated environment such as a SSO based application. The user information is extracted from the authenticated environment and a workflow context is returned for that user (Object request (Either instance of PortletRequest or HttpServletRequest) is from an authenticated user)

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Parameters:
      request - The pre-authenticated HttpServletRequest/PortletRequest to create the workflow context for
      Returns:
      IWorkflowContext the workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • authenticate

      IWorkflowContext authenticate(String user, String password, String identityContext, String onBehalfOfUser) throws WorkflowException
      Deprecated.
      since 11. Use authenticate(String, char[], String) or authenticateOnBehalfOf(IWorkflowContext, String)
      authenticate is used for authenticating a user with the identity authentication service based on the specified user/password and returns a workflow context.

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Parameters:
      user - the name of the user who needs to be authenticated
      password - the password of the user who needs to be authenticated
      identityContext - the identityContext (usually realm) of the user
      onBehalfOfUser - The user on behalf of whom the context should be created (Admin can authenticate on behalf of another user, and get the workflow context for the user specified in onBehalfOfUser)
      Returns:
      IWorkflowContext the workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • authenticate

      IWorkflowContext authenticate(String user, char[] password, String identityContext) throws WorkflowException
      authenticate is used for authenticating a user with the identity authentication service based on the specified user/password and returns a workflow context.

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Parameters:
      user - the name of the user who needs to be authenticated
      password - the password of the user who needs to be authenticated
      identityContext - the identityContext (usually realm) of the user
      Returns:
      IWorkflowContext the workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • authenticateOnBehalfOf

      IWorkflowContext authenticateOnBehalfOf(IWorkflowContext adminWorkflowContext, String onBehalfOfUser) throws WorkflowException
      Admin can authenticate on behalf of another user, and get the workflow context for the user specified in onBehalfOfUser

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Parameters:
      IWorkflowContext - the workflow context of the admin
      onBehalfOfUser - The user on behalf of whom the context should be created
      Returns:
      IWorkflowContext the workflow context for the user specified in onBehalfOfUser
      Throws:
      WorkflowException - any exception thrown during authentication

    • getWorkflowContextForAuthenticatedUser

      IWorkflowContext getWorkflowContextForAuthenticatedUser() throws WorkflowException
      Gets WorkflowContext for already authenticated user and whose identity is propagated to server The method returns valid context only if user identity is propagated to the service and context is still valid, else the method throws WorkflowException exception

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Returns:
      IWorkflowContext object.
      Throws:
      WorkflowException - any exception thrown during authentication

    • getWorkflowContext

      IWorkflowContext getWorkflowContext(String ctxToken) throws WorkflowException
      getWorkflowContext is used for retrieving a workflow context based on the given token.

      If a IWorkflowContext instance is not used for within the timeout defined in the workflow configuration, it would become invalid and can't be used further in workflow service calls because a WorkflowException would be thrown. If this occurs a new IWorkflowContext instance would have to be obtained. When IWorkflowContext instance isn't needed any more (such as a logout from an application) it has to be destroyed to free up memory used in the service by that corresponding session. To destroy a IWorkflowContext instance see destroyWorkflowContext() method.

      Parameters:
      ctxToken - the token to be used for retrieving the context
      Returns:
      IWorkflowContext the workflow context
      Throws:
      WorkflowException - any exception thrown during retrieval

    • destroyWorkflowContext

      void destroyWorkflowContext(IWorkflowContext ctx) throws WorkflowException
      destroyWorkflowContext is used for cleaning up a workflow context that is no longer needed. This will free up the memory used for storing the workflow context. This is used typically when a user logs out..
      Parameters:
      ctx - the workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • refreshWorkflowContext

      IWorkflowContext refreshWorkflowContext(IWorkflowContext ctx) throws WorkflowException
      refreshWorkflowContext is used for refreshing session and updating user cache associated with this context The method synchronizes privilages, app roles and group granted to workflow context user with security provider. The method returns a new WorflowContext instance
      Parameters:
      ctx - the workflow context
      Returns:
      IWorkflowContext a new refreshed workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • updateWorkflowContext

      IWorkflowContext updateWorkflowContext(IWorkflowContext ctx, Map<ITaskQueryService.ATTRIBUTE,Object> attributes, boolean force) throws WorkflowException
      updateWorkflowContext is used for update workflow context with attribute values provided in the map The method returns a new WorflowContext instance
      Parameters:
      ctx - the workflow context
      attributes - an instance of Map<ATTRIBUTE, Object> , a name value pair, where ATTRIBUTE is an enumeration and value is any instance of the attribute. For instance for locale it must be Locale instance.
      force - a boolean flag. If true, the values from the map overwrites the values in WorkflowConext, otherwise the method overwrites only if user's attribute (for instance locale or timeZone) is null or does not exist in the identity provider
      Returns:
      IWorkflowContext a new updated workflow context
      Throws:
      WorkflowException - any exception thrown during authentication

    • queryTasks

      List queryTasks(IWorkflowContext ctx, List displayColumns, List optionalInformation, String assignmentFilter, String keywords, Predicate predicate, Ordering ordering, int startRow, int endRow) throws WorkflowException
      Deprecated.
      queryTasks returns a list of tasks (Task Objects). The assignmentFilter is used to filter the tasks based on the task assignment. The tasks returned can be restricted by specifying valid values (>0) for the startRow and endRow to facilitate database level paging. If these values are set to 0 then the first 200 qualifying tasks are returned.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      assignmentFilter - the filter for task assignment 
       For all possible values, check the assignment filters defined in this interface, 
 like ASSIGNMENT_FILTER_<Filter Name>
      displayColumns - a list containing names of columns to be retrieved 
       For those columns that are not specified here, the queried Task object will not hold any value.
 For example: If TITLE is not specified, task.getTitle() will return null
 For the complete list of columns that can be specified here, check the table shown above
 Note: TASKID is fetched by default. So there is no need to explicitly specity it.

 If displayColumns is null or has no elements, then the following columns will be returned
 by default:

  
      
  
       Column
      
  
      WFTASK_TASKID_COLUMN 
      
  
      WFTASK_TASKGROUPID_COLUMN
      
  
      WFTASK_TASKNUMBER_COLUMN
      
  
      WFTASK_TASKDEFINITIONID_COLUMN
      
  
      WFTASK_TASKGROUPINSTANCEID_COLUMN
      
  
      WFTASK_SUBTASKGROUPINSTANCEID_COLUMN
      
  
      WFTASK_ACQUIREDBY_COLUMN
      
  
      WFTASK_ASSIGNEES_COLUMN
      
  
      WFTASK_REVIEWERS_COLUMN
      
  
      WFTASK_CREATOR_COLUMN
      
  
      WFTASK_OWNERUSER_COLUMN
      
  
      WFTASK_OWNERGROUP_COLUMN
      
  
      WFTASK_DIGITALSIGNATUREREQUIRED_COLUMN
      
  
      WFTASK_EXPIRATIONDATE_COLUMN
      
  
      WFTASK_PRIORITY_COLUMN
      
  
      WFTASK_ASSIGNEDDATE_COLUMN
      
  
      WFTASK_CREATEDDATE_COLUMN
      
  
      WFTASK_ENDDATE_COLUMN
      
  
      WFTASK_STATE_COLUMN
      
  
      WFTASK_UPDATEDBY_COLUMN
      
  
      WFTASK_UPDATEDDATE_COLUMN
      
  
      WFTASK_WORKFLOWPATTERN_COLUMN
      
  
      WFTASK_TITLE_COLUMN
      
  
      WFTASK_CATEGORY_COLUMN
      
  
      WFTASK_DUEDATE_COLUMN
      
  
      WFTASK_PERCENTAGECOMPLETE_COLUMN
      
  
      WFTASK_STARTDATE_COLUMN
      
  
      WFTASK_TASKDISPLAYURL_COLUMN
      optionalInformation - a list specifying optional information to be retrieved 
       Possible Values:
 1) Actions (All actions that can be performed on the task)
 2) GroupActions (Only group Actions: Actions that can be performed on a group of tasks)
 3) CustomActions (Custom actions applicable to the specific task type)
 4) ShortHistory (A concise history of changes made to the task)
 All optionalInfo specified can be fetched from the Task object
  For example: if you have specified "CustomActions", you can retrieve
  it using task.getSystemAttributes().getCustomActions();
  Actions" (All Actions) - task.getSystemAttributes().getSystemActions()
  "GroupActions" (Only group Actions)- task.getSystemAttributes().getSystemActions()
  "ShortHistory" - task.getSystemAttributes().getShortHistory()
 The following is reserved for future use.
 If you need them, please use getTaskDetailsById (or) getTaskDetailsByNumber,
 which will fetch all information related to a task, which includes these
 Attachments
 Comments
 Payload
      keywords - an optional search string 
       If this keyword is null, it is omitted from all query. If not null, predicates 
 will be added to the query predicate to perform SQL 'like' operation (this method 
 will add the sql % around the keyword: %$lt;keyword>%) on the following task 
 attributes: task title, identification key, all textAttributes in task, task 
 number (only if the keyword is a number)
      predicate - the predicate for filtering the tasks
      ordering - the ordering criteria for sorting the tasks
      startRow - the rownum of the starting row returned by this query. Used for paging queries. If startRow is zero or less, list will start with the first row selected by the query.
      endRow - the rownum of the ending row for this query. If endRow is zero or less, paging size defaults to 200; up to 200 rows will be returned (depending on the number of rows actually returned by the query).
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks

    • queryTasks

      List<Task> queryTasks(IWorkflowContext ctx, List displayColumns, List<ITaskQueryService.OptionalInfo> optionalInformation, ITaskQueryService.AssignmentFilter assignmentFilter, String keywords, Predicate predicate, Ordering ordering, int startRow, int endRow) throws WorkflowException
      queryTasks returns a list of tasks that match the predicate and ordering criterion. The assignmentFilter is used to filter the tasks based on the task assignment. The tasks returned can be restricted by specifying valid values (>0) for the startRow and endRow to facilitate database level paging. If these values are set to 0 then the first 200 qualifying tasks are returned.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      assignmentFilter - the filter for task assignment. Mandatory paramter. 
       For all possible values, check the list of assignment filters defined 
 in this interface, in the enum AssignmentFilter
      displayColumns - a list containing names of columns to be retrieved 
       For those columns that are not specified here, the queried Task object will not hold any value.
 For example: If TITLE is not specified, task.getTitle() will return null
 For the complete list of columns that can be specified here, check the table shown above
 Note: TASKNUMBER and TASKID are fetched by default. So there is no need to explicitly specity it.

 If displayColumns is null or has no elements, then the following columns will be returned
 by default:

  
      
  
       Column
      
  
      WFTASK_TASKID_COLUMN 
      
  
      WFTASK_TASKGROUPID_COLUMN
      
  
      WFTASK_TASKNUMBER_COLUMN
      
  
      WFTASK_TASKDEFINITIONID_COLUMN
      
  
      WFTASK_TASKGROUPINSTANCEID_COLUMN
      
  
      WFTASK_SUBTASKGROUPINSTANCEID_COLUMN
      
  
      WFTASK_ACQUIREDBY_COLUMN
      
  
      WFTASK_ASSIGNEES_COLUMN
      
  
      WFTASK_REVIEWERS_COLUMN
      
  
      WFTASK_CREATOR_COLUMN
      
  
      WFTASK_OWNERUSER_COLUMN
      
  
      WFTASK_OWNERGROUP_COLUMN
      
  
      WFTASK_DIGITALSIGNATUREREQUIRED_COLUMN
      
  
      WFTASK_EXPIRATIONDATE_COLUMN
      
  
      WFTASK_PRIORITY_COLUMN
      
  
      WFTASK_ASSIGNEDDATE_COLUMN
      
  
      WFTASK_CREATEDDATE_COLUMN
      
  
      WFTASK_ENDDATE_COLUMN
      
  
      WFTASK_STATE_COLUMN
      
  
      WFTASK_UPDATEDBY_COLUMN
      
  
      WFTASK_UPDATEDDATE_COLUMN
      
  
      WFTASK_WORKFLOWPATTERN_COLUMN
      
  
      WFTASK_TITLE_COLUMN
      
  
      WFTASK_CATEGORY_COLUMN
      
  
      WFTASK_DUEDATE_COLUMN
      
  
      WFTASK_PERCENTAGECOMPLETE_COLUMN
      
  
      WFTASK_STARTDATE_COLUMN
      
  
      WFTASK_TASKDISPLAYURL_COLUMN
      optionalInformation - a list specifying optional information to be retrieved 
       Possible Values: (Refer to the enum OptionalInfo, defined in this interface)
 1) ALL_ACTIONS (All actions that can be performed on the task)
 2) GROUP_ACTIONS (Only group Actions: Actions that can be performed on a group of tasks)
 3) CUSTOM_ACTIONS (Custom actions applicable to the specific task type)
 4) SHORT_HISTORY (A concise history of changes made to the task)
 5) DISPLAY_INFO (Information relating to the URI for the task details display page)
 All optionalInfo specified can be fetched from the Task object
  For example: if you have specified "CUSTOM_ACTIONS", you can retrieve
  it using task.getSystemAttributes().getCustomActions();
  "ALL_ACTIONS" (All Actions) - task.getSystemAttributes().getSystemActions()
  "GROUP_ACTIONS" (Only group Actions)- task.getSystemAttributes().getSystemActions()
  "SHORT_HISTORY" - task.getSystemAttributes().getShortHistory()
  "DISPLAY_INFO" - task.getSystemAttributes().getDisplayInfo()
  "ATTACHMENTS"  - task.getAttachment()
  "COMMENTS"     - task.getAddedComment() 
  "PAYLOAD"      - task.getPayloadAsElement()
      If optionalInformation is null, then no addtional information will be retrieved.
      keywords - an optional search string. 
       If this keyword is null, it is omitted from all query. If not null, predicates 
 will be added to the query predicate to perform SQL 'like' operation (this method 
 will add the sql % around the keyword: %<keyword>%) on the following task 
 attributes: task title, identification key, all textAttributes in task, task 
 number (only if the keyword is a number)
      predicate - the predicate for filtering the tasks. Optional parameter - may be null.
      ordering - the ordering criteria for sorting the tasks. Optional parameter - if no value is set, the tasks wil be ordered by task number.
      startRow - the rownum of the starting row for this query. If startRow is zero or less, list will contain rows from the start of the queried rows.
      endRow - the rownum of the ending row for this query. If endRow is zero or less, paging size defaults to 200; up to 200 rows will be returned (depending on the number of rows actually returned by the query).
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks

    • queryTasks

      List<Task> queryTasks(IWorkflowContext ctx, String presentationId, ITaskQueryService.AssignmentFilter assignmentFilter, String keywords, Predicate predicate, int startRow, int endRow) throws WorkflowException
      queryTasks returns a list of tasks that match the predicate. The columns queryied and the order of the returned tasks are determined by the specified Presentation.

      The user must have access to the specified presentation (must be the presentation owner, a grantee, or have andmin privileges).

      The assignmentFilter is used to filter the tasks based on the task assignment. The tasks returned can be restricted by specifying valid values (>0) for the startRow and endRow to facilitate database level paging. If these values are set to 0 then the first 200 qualifying tasks are returned.

      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      presentationId - the id of the Presentation to use for this query. The columns and optional info specified in the presetation will be queried, and the query results will be ordered according to the ordering clauses in the Presentation.
      assignmentFilter - the filter for task assignment. Mandatory paramter. 
       For all possible values, check the list of assignment filters defined 
 in this interface, in the enum AssignmentFilter
      keywords - an optional search string. 
       If this keyword is null, it is omitted from all query. If not null, predicates 
 will be added to the query predicate to perform SQL 'like' operation (this method 
 will add the sql % around the keyword: %<keyword>%) on the following task 
 attributes: task title, identification key, all textAttributes in task, task 
 number (only if the keyword is a number)
      predicate - the predicate for filtering the tasks. Optional parameter - may be null.
      startRow - the rownum of the starting row for this query. If startRow is zero or less, list will contain rows from the start of the queried rows.
      endRow - the rownum of the ending row for this query. If endRow is zero or less, paging size defaults to 200; up to 200 rows will be returned (depending on the number of rows actually returned by the query).
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks

    • queryAggregatedTasks

      List<TaskCountType> queryAggregatedTasks(IWorkflowContext ctx, Column groupByColumn, ITaskQueryService.AssignmentFilter assignmentFilter, String keywords, Predicate predicate, boolean orderByCount, boolean ascendingOrder) throws WorkflowException
      Executes the specified query, and aggregates a count of the tasks returned by the query, grouped by the specified column. Typically used by clients to query data for displaying a bar chart summary of task data - for example, a chart showing the distribution of tasks by task state. Clients can specify query parameters, the column the task counts should be grouped by, and how the results should be ordered.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      groupByColumn - the Column the task counts should be grouped by.
      assignmentFilter - the filter for task assignment 
       For all possible values, check the list of assignment filters defined 
 in this interface, in the enum AssignmentFilter. Mandatory parameter.
      keywords - an optional search string. 
       If this keyword is null, it is omitted from all query. If not null, predicates 
 will be added to the query predicate to perform SQL 'like' operation (this method 
 will add the sql % around the keyword: %<keyword>%) on the following task 
 attributes: task title, identification key, all textAttributes in task, task 
 number (only if the keyword is a number)
      predicate - the Predicate for filtering the tasks. Optional parameter - may be null.
      orderByCount - if true, results will be ordered by the counts, if false, results will be ordered by the values of the groupBy column.
      ascendingOrder - if true, results will be in ascending order, otherwise results will be in descending order.
      Returns:
      a List of TaskCountType objects. Each TaskCountType object has a value field containing a value from the groupBy column and a count field containing the number of tasks that have that value.
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks.

    • countTasks

      int countTasks(IWorkflowContext ctx, ITaskQueryService.AssignmentFilter assignmentFilter, String keywords, Predicate predicate) throws WorkflowException
      Counts the number of tasks that match the specified query criteria. Using this method is generally more performant than using queryTasks and getting the size of the returned List.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      assignmentFilter - the filter for task assignment 
       For all possible values, check the list of assignment filters defined 
 in this interface, in the enum AssignmentFilter. Mandatory parameter.
      keywords - an optional search string. 
       If this keyword is null, it is omitted from all query. If not null, predicates 
 will be added to the query predicate to perform SQL 'like' operation (this method 
 will add the sql % around the keyword: %<keyword>%) on the following task 
 attributes: task title, identification key, all textAttributes in task, task 
 number (only if the keyword is a number)
      predicate - the Predicate for filtering the tasks. Optional parameter - may be null.
      Returns:
      int number of tasks that match the specified query criteria. If no tasks are found, returns 0.
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks.

    • doesTaskExist

      boolean doesTaskExist(IWorkflowContext ctx, ITaskQueryService.AssignmentFilter assignmentFilter, String keywords, Predicate predicate) throws WorkflowException
      Checks to see if any tasks exist that match the specified query criteria. Using this method is generatlly more performant than using queryTasks or countTasks, especially where a large number of tasks match the query criteria.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      assignmentFilter - the filter for task assignment 
       For all possible values, check the list of assignment filters defined 
 in this interface, in the enum AssignmentFilter. Mandatory parameter.
      keywords - an optional search string. 
       If this keyword is null, it is omitted from all query. If not null, predicates 
 will be added to the query predicate to perform SQL 'like' operation (this method 
 will add the sql % around the keyword: %<keyword>%) on the following task 
 attributes: task title, identification key, all textAttributes in task, task 
 number (only if the keyword is a number)
      predicate - the Predicate for filtering the tasks. Optional parameter - may be null.
      Returns:
      boolean true if any tasks match the specified query criteria, otherwise false.
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks.

    • queryViewTasks

      List queryViewTasks(IWorkflowContext ctx, String viewId, Predicate extraPredicate, Ordering defaultOrdering, int startRow, int endRow) throws WorkflowException
      queryViewTasks returns a list of tasks that match the criterion specified in the view such as columns, optional info, assignmentFilter, keywords, predicate, ordering.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      viewId - the view id of the view whose tasks need to be retrieved (Views can be created using IUserMetadataService)
      extraPredicate - optional extra Predicate on top of the view predicate for filtering the tasks.
      defaultOrdering - the default ordering criteria that overrides view ordering for sorting the tasks
      startRow - the rownum of the starting row for this query. If startRow is zero or less, list will contain rows from the start of the queried rows.
      endRow - the rownum of the ending row for this query. If endRow is zero or less, paging size defaults to 200; up to 200 rows will be returned (depending on the number of rows actually returned by the query).
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks

    • querySharedViewTasks

      List querySharedViewTasks(IWorkflowContext ctx, String viewId, Predicate extraPredicate) throws WorkflowException
      querySharedViewTasks returns a list of tasks for supplied viewId and predicate. For deleted view owner also these will method fetch the tasks.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      viewId - the view id of the view whose tasks need to be retrieved (Views can be created using IUserMetadataService)
      extraPredicate - optional extra Predicate on top of the view predicate for filtering the tasks.
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks

    • queryViewAggregatedTasks

      List<TaskCountType> queryViewAggregatedTasks(IWorkflowContext ctx, String viewId, Predicate extraPredicate, Column defaultGroupByColumn, boolean defaultOrderByCount, boolean defaultAscendingOrder) throws WorkflowException
      Executes the query as defined in the specified view, and agregates the selected tasks according to the chart property defined in the view. The chart property of a view is an instance of a ChartType, and defines the following properties:
      • groupByColumn String The name of the column the task counts should be grouped by.
      • selectValues ChartType.SelectValuesType optionally specifies a list of values from the groupByColumn that should be selected for aggregation. If no selectValues are selected, then all agregation is over all values of the groupBy column
      • orderByCount boolean if true, results will be ordered by the counts, if false, results will be ordered by the values of the group by column.
      • ascendingOrder boolean if true, results will be in ascending order, otherwise results will be in descending order.
      If no chart property is defined for the view, then the default values specified in the call to this method will be used instead. An additional predicate can be optionally specified to further restrict the tasks queried by the view.
      Parameters:
      ctx - ctx the workflow context (can contain valid token or credentials)
      viewId - the view id of the view whose tasks need to be retrieved (Views can be created using IUserMetadataService)
      extraPredicate - optional extra Predicate on top of the view predicate for filtering the tasks.
      defaultGroupByColumn - if the view does not specify a chart groupBy column this parameter specifies the to be used group the task counts.
      defaultOrderByCount - specifies how tasks counts should be ordered if the view does not specify ordering.
      defaultAscendingOrder - specifies how tasks counts should be ordered if the view does not specify ordering.
      Returns:
      a List of TaskCountType objects. Each TaskCountType object has a value field containing a value from the groupBy column and a count field containing the number of tasks that have that value.
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks.

    • countViewTasks

      int countViewTasks(IWorkflowContext ctx, String viewId, Predicate extraPredicate) throws WorkflowException
      Counts the number of tasks that match the query criteria of the specified view. Using this method is generally more performant than using queryViewTasks and getting the size of the returned List.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      viewId - the view id of the view whose tasks are to be counted.
      extraPredicate - optional extra Predicate on top of the view predicate for filtering the tasks.
      Returns:
      int number of tasks that match the specified view, and additional predicate (if any). If no tasks are found, returns 0.
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks.

    • doesViewTaskExist

      boolean doesViewTaskExist(IWorkflowContext ctx, String viewId, Predicate extraPredicate) throws WorkflowException
      Checks to see if any tasks exist match the query criteria of the specified view. Using this method is generatlly more performant than using queryViewTasks or countViewTasks, especially where a large number of tasks match the query criteria.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      viewId - the view id of the view whose tasks are to be counted.
      extraPredicate - optional extra Predicate on top of the view predicate for filtering the tasks.
      Returns:
      boolean true if any tasks match the specified query criteria, otherwise false.
      Throws:
      WorkflowException - if any runtime error occurs while querying tasks.

    • queryDecomposedTasks

      List<Task> queryDecomposedTasks(IWorkflowContext ctx, String parentTaskId, List<String> displayColumns, List<ITaskQueryService.OptionalInfo> optionalInfo, String keywords, Predicate predicate, Ordering ordering, int startRow, int endRow) throws WorkflowException
      Queries a list of sub-tasks that have been decomposed from the specified parent task instance. The returned list can be restricted by providing an optional keywords or predicate to search on.

      A decomposed task can be created by a call to ITaskService.decomposeTask(oracle.bpel.services.workflow.verification.IWorkflowContext, java.lang.String, oracle.bpel.services.workflow.metadata.routingslip.model.RoutingSlip, oracle.bpel.services.workflow.task.model.DecomposeTaskInfo).

      This method will only return direct sub-tasks - if a decomposed sub-task is further decomposed, those 'sub-sub-tasks' wont be included in the list returned by this method for the original parent task. The 'sub-sub-tasks' may be returned by passing the taskId of the decomposed sub-task they were decomposed from to this method.

      The fields that should be populated on the on the returned Task objects can be specfied by the displayColumns and optionalInfo parameters.

      The ordering of the returned list can be specified using the ordering paramter. The list of returned tasks can be paged by specifying a startRow and endRow.

      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      parentTaskId - the taskId of the task to query the decomposed tasks for
      displayColumns - a list containing names of columns to be retrieved. Refer to 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) for a description of this parameter.
      optionalInfo - a list specifying optional information to be retrieved. Refer to 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) for a description of this parameter.
      keywords - an optional search string. Refer to 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) for a description of this parameter.
      predicate - the predicate for filtering the tasks. Optional parameter - may be null.
      ordering - the ordering criteria for sorting the tasks. Optional parameter - if no value is set, the tasks wil be ordered by task number.
      startRow - the rownum of the starting row for this query. If startRow is zero or less, list will contain rows from the start of the queried rows.
      endRow - the rownum of the ending row for this query. If endRow is zero or less, paging size defaults to 200; up to 200 rows will be returned (depending on the number of rows actually returned by the query).
      Returns:
      List of Tasks that have been decomposed from the specified parent task instance, and match any additional criteria specified in the method call.
      Throws:
      WorkflowException

    • queryTaskErrors

      List<oracle.bpel.services.workflow.task.error.model.TaskError> queryTaskErrors(IWorkflowContext ctx, Predicate predicate, Ordering ordering, int startRow, int endRow) throws WorkflowException
      queryTaskErrors returns a list of TaskError objects matching the specified predicate
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      predicate - the predicate for filtering the task errors
      ordering - the ordering criteria for sorting the task errors
      startRow - the rownum of the starting row for this query. If startRow is zero or less, list will contain rows from the start of the queried rows.
      endRow - the rownum of the ending row for this query. If endRow is zero or less, paging size defaults to 200; up to 200 rows will be returned (depending on the number of rows actually returned by the query).
      Returns:
      Throws:
      WorkflowException

    • getTaskHistory

      List getTaskHistory(IWorkflowContext ctx, String taskId) throws WorkflowException
      Deprecated.
      use @link{#getTaskHistory(IWorkflowContext, String, List)} instead.
      getTaskHistory returns a list of historical task versions for the specified taskId.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskId - the id of the task whose history is needed
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while getting task versions

    • getTaskHistory

      List<Task> getTaskHistory(IWorkflowContext ctx, String taskId, List<String> displayColumns) throws WorkflowException
      getTaskHistory returns a list of historical task versions for the specified taskId.
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskId - the id of the task whose history is needed
      displayColumns - a list containing names of columns to be retrieved 
       For those columns that are not specified here, the queried Task object will not hold any value.
 For example: If TITLE is not specified, task.getTitle() will return null
 For the complete list of columns that can be specified here, check the table shown above
 
 If displayColumns is null or has no elements, then the following columns will be returned
 by default:

  
      
  
       Column
      
  
      WFTASKHISTORY_TASKID_COLUMN
      
  
      WFTASKHISTORY_TASKGROUPID_COLUMN
      
  
      WFTASKHISTORY_TASKNUMBER_COLUMN
      
  
      WFTASKHISTORY_VERSION_COLUMN
      
  
      WFTASKHISTORY_VERSIONREASON_COLUMN
      
  
      WFTASKHISTORY_STATE_COLUMN
      
  
      WFTASKHISTORY_ASSIGNEES_COLUMN
      
  
      WFTASKHISTORY_UPDATEDDATE_COLUMN
      
  
      WFTASKHISTORY_UPDATEDBY_COLUMN
      
  
      WFTASKHISTORY_USERCOMMENT_COLUMN
      
  
      WFTASKHISTORY_OUTCOME_COLUMN
      Returns:
      a list of Task objects
      Throws:
      WorkflowException - if any runtime error occurs while getting task versions

    • getTaskDetailsById

      Task getTaskDetailsById(IWorkflowContext ctx, String taskId) throws WorkflowException
      getTaskDetailsById gets the details of a task whose id is taskId
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskId - the id of the task whose details are needed
      Returns:
      an Task object
      Throws:
      WorkflowException - if any runtime error occurs while getting task details

    • getTaskDetailsByNumber

      Task getTaskDetailsByNumber(IWorkflowContext ctx, int taskNumber) throws WorkflowException
      getTaskDetailsByNumber gets the details of a task whose number is taskNumber
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskNumber - the number of the task whose details are needed
      Returns:
      an Task object
      Throws:
      WorkflowException - if any runtime error occurs while getting task details

    • getTaskVersionDetails

      Task getTaskVersionDetails(IWorkflowContext ctx, String taskId, int versionNumber) throws WorkflowException
      getTaskVersionDetails gets the task version details of a task whose id is taskId for the version denoted by versionNumber
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskId - the id of the task whose details are needed
      versionNumber - the version number of the task
      Returns:
      an Task object
      Throws:
      WorkflowException - if any runtime error occurs while getting task details

    • getTaskSequence

      TaskSequence getTaskSequence(IWorkflowContext ctx, Task task, List<String> taskDisplayColumns, List<ITaskQueryService.TaskSequenceType> taskSequenceType, List<ITaskQueryService.TaskSequenceBuilderContext> taskSequenceBuilderContext, boolean fetchTaskSequenceForRootTask) throws WorkflowException
       getTaskSequence gets the task sequence tree of a task whose id is taskId,
 for those type of sequence specified in sequenceTypes
 There are 4 types of objects in the returned tree. Each of these objects 
 implement the ITaskSequence interface.
 
        
 
      1. TaskSequence. This node represents a sequence of nodes. This 
 node is always the root object and will also be the wrapper around a 
 parallel branch if there is more than one node in that branch. The 
 objects in the getChildren() method could be Parallel, SequenceGroup or 
 TaskSequenceRecord.
        2. 
 
      2. Parallel. This node represents a parallel events in the task. 
 Each node in the getChildren() method represents one parallel branch. The 
 objects in the getChildren() method could be Sequence, SequenceGroup, 
 Parallel or TaskSequenceRecord. If there are more than one node in any 
 parallel branch, then all those nodes will be wrapped by a Sequence 
 object. If the client wants each parallel branch to be wrapped with a 
 TaskSequence object, it could pass 
 TaskSequenceBuilderContext.INCLUDE_SEQUENCE_FOR_SINGLE_CHILD in the 
 List<TaskSequenceBuilderContext> parameter of the getTaskSequence method.
        3. 
 
      3. SequenceGroup. The SequenceGroup object represents a sequence 
 of nodes that are grouped because they belong to the same workflow 
 pattern like management chain or sequential participant. The objects 
 in the getChildren() method are always TaskSequenceRecord objects. By 
 default there will be no SequenceGroup objects. If the client wants 
 workflow patterns to be captured as SequenceGroup objects in the 
 TaskSequence tree, it could pass TaskSequenceBuilderContext.WORKFLOW_PATTERN 
 in the List<TaskSequenceBuilderContext> parameter of the getTaskSequence 
 method.
        4. 
 
      4. TaskSequenceRecord. This object represents actual update to the 
 task or a future assignment. It doesn't have any children.
        5. 
 
      
 Attributes in each of ITaskSequence objects are:
 
 
      
 
      
 Attribute
 TaskSequence
 Parallel
 SequenceGroup
 TaskSequenceRecord
 
      
 
      
 Id
 Not populated by default
 Not populated by default
 Not populated by default
 Not populated by default
 
      
 
      
 SequenceNumber
 Populated by default
 Populated by default
 Populated by default
 Populated by default
 
      
 
      
 Label
 Not applicable
 The name of the parallel pattern as specified during design time
 The name of the workflow pattern node as specified during design time
 The name of the workflow pattern node as specified during design time
 
      
 
      
 Pattern
 Not applicable
 ITaskSequence.Pattern.Parallel
 ITaskSequence.Pattern.ManagementChain or ITaskSequence.Pattern.SequentialParticipant
 ITaskSequence.Pattern.*
 
      
 
      
 Name
 Not applicable
 Same as label
 Same as label
 Concatenated string of the assignees
 
      
 
      
 FlexString1-5
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 
      
 
      
 
 
 Note:
 
        
 
      1. None of the attributes are set on the root TaskSequence object.
        2. 
 
      2. ITaskSequence.Pattern.Stage and TaskSequenceBuilderContext.STAGE are reserved for future use.
        3. 
 
      
 
 Retrieving the task sequence with either the task or taskid
 TaskSequence can be retrieved with either the task or the task id. The usage is shown below:
 
      ITaskQueryService querySvc = ...
      List<ITaskQueryService.TaskSequenceType> sequenceTypes =
          new ArrayList<ITaskQueryService.TaskSequenceType>();
      sequenceTypes.add(ITaskQueryService.TaskSequenceType.ALL);
 
      List<ITaskQueryService.TaskSequenceBuilderContext> taskSequenceBuilderContext =
          new ArrayList<ITaskQueryService.TaskSequenceBuilderContext>();
      taskSequenceBuilderContext.add(ITaskQueryService.TaskSequenceBuilderContext.WORKFLOW_PATTERN);
 
      TaskSequence taskSequence =
          querySvc.getTaskSequence(ctx, task, null, sequenceTypes,
                                   taskSequenceBuilderContext, true);
 or
      TaskSequence taskSequence =
          querySvc.getTaskSequence(ctx, taskId, null, sequenceTypes,
                                   taskSequenceBuilderContext, true);

 
 
 Retrieving the task sequence before initiating the task
 TaskSequence can be retrieved without initiating the task, in which case the task sequence 
 will contain only the future participants. To do this, clients have to set the task definition id 
 in the task. The task definition id is either the targetNamespace of the corresponding .task file
 or the id created for the deployed workflow component during deployment. The usage is shown below:
 
      ITaskQueryService querySvc = ...
      Task task = new ObjectFactory().createTask();
      Element inputPayload = getInputPayload();
 
      // optionally set the task creator
      task.setCreator(name);
 
      // optionally set the task payload
      Document document = XMLUtil.createDocument();
      Element payloadElem = document.createElementNS(TASK_NS, "payload");
      Element cloneTemp =
          (Element)document.importNode(inputPayload, true);
      payloadElem.appendChild(cloneTemp);
      document.appendChild(payloadElem);
      task.setPayloadAsElement(payloadElem);
 
      List<ITaskQueryService.TaskSequenceType> sequenceTypes =
          new ArrayList<ITaskQueryService.TaskSequenceType>();
      sequenceTypes.add(ITaskQueryService.TaskSequenceType.ALL);
 
      List<ITaskQueryService.TaskSequenceBuilderContext> taskSequenceBuilderContext =
          new ArrayList<ITaskQueryService.TaskSequenceBuilderContext>();
      taskSequenceBuilderContext.add(ITaskQueryService.TaskSequenceBuilderContext.WORKFLOW_PATTERN);
 
      TaskSequence taskSequence =
          querySvc.getTaskSequence(ctx, task, null, sequenceTypes,
                                   taskSequenceBuilderContext, true);
 
 
 Setting additional attributes on the retrieved task sequence
 It is often necessary for the clients to set other data on the task sequence before using it. For 
 example, the client might want to dispaly the task sequence in a table with some image hints 
 based on pattern. The following code illustrates use of the flex strings to do this:
 
    TaskSequence taskSequence = ...;
    setImage(taskSequence);
 
    private void setImage(ITaskSequence taskSequence) {
        ITaskSequence.Pattern pattern = taskSequence.getPattern();
        System.out.println(pattern);
        if (pattern == ITaskSequence.Pattern.ManagementChain) {
            taskSequence.setFlexString1("sequential.png");
        } else if (pattern == ITaskSequence.Pattern.Parallel) {
            taskSequence.setFlexString1("parallel.png");
        } else if (pattern == ITaskSequence.Pattern.Participant) {
            taskSequence.setFlexString1("user.png");
        } else if (pattern == ITaskSequence.Pattern.SequentialParticipant) {
            taskSequence.setFlexString1("sequential.png");
        }
 
        List children = taskSequence.getChildren();
        if (children != null) {
            for (int index = 0; index < children.size(); index++) {
                ITaskSequence taskSequenceChild =
                    (ITaskSequence)children.get(index);
                setImage(taskSequenceChild);
            }
        }
    }
 
 
 Setting additional attributes on the retrieved task sequence
 The following code shows how to create an ADF TreeModel from the task sequence
 
    List rootListNode = new ArrayList();
    rootListNode.addAll(taskSequence.getChildren());
    org.apache.myfaces.trinidad.model.TreeModel treeModel = new ChildPropertyTreeModel(rootListNode, "children");
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      task - the task whose details are needed
      taskDisplayColumns - the task columns to query
      taskSequenceType - a list containing type of task sequence type to be retrieved
      taskSequenceBuilderContext - a list containing context to the task sequence true builder
      fetchTaskSequenceForRootTask - If true, get the task sequence for the root task, else get the task sequence for the current task. The root task is the main task which could have sub tasks that represent parallel tasks
      Returns:
      an TaskSequence object, which the represents the task sequence tree
      Throws:
      WorkflowException - if any runtime error occurs while getting task sequence

    • getTaskSequence

      TaskSequence getTaskSequence(IWorkflowContext ctx, String taskId, List<String> taskDisplayColumns, List<ITaskQueryService.TaskSequenceType> taskSequenceType, List<ITaskQueryService.TaskSequenceBuilderContext> taskSequenceBuilderContext, boolean fetchTaskSequenceForRootTask) throws WorkflowException
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskId - the taskId of the task whose details are needed
      taskDisplayColumns - the task columns to query
      taskSequenceType - a list containing type of task sequence type to be retrieved
      taskSequenceBuilderContext - a list containing context to the task sequence true builder
      fetchTaskSequenceForRootTask - If true, get the task sequence for the root task, else get the task sequence for the current task. The root task is the main task which could have sub tasks that represent parallel tasks
      Returns:
      an TaskSequence object, which the represents the task sequence tree
      Throws:
      WorkflowException - if any runtime error occurs while getting task sequence
      See Also:

    • getPermittedAssignees

      oracle.bpel.services.workflow.task.IRestrictedAssignees getPermittedAssignees(IWorkflowContext ctx, Task task, String operation) throws WorkflowException
      getPermittedAssignees gets a list of users to whom the current task can be reassigned to by the current user.
      Parameters:
      ctx - the workflow context.
      task - the task being operated upon
      operation - the operation. One of the constants from the call back interface.
      Returns:
      a IRestrictedAssignees object representing the permitted users set.
      Throws:
      WorkflowException - if any runtime error occurs while obtaining the list of users.

    • getPermittedAssigneesForTasks

      oracle.bpel.services.workflow.task.IRestrictedAssignees getPermittedAssigneesForTasks(IWorkflowContext ctx, List<String> taskIdList, String operation, String participantType, SearchFilter filter, String appRoleNamePattern, String appId) throws WorkflowException
      getPermittedAssigneesForTasks gets a list of users to whom current set of tasks can be reassigned to by the current user. This differs from the older API as it deals with restricted assignment when doing bulk reassignment of tasks, takes excluded participant, as well as org unit restrictions into consideration
      Parameters:
      ctx - : the workflow context
      taskList - : the set of tasks undergoing bulk reassignment(task Ids)
      operation - : the operation, One of the constants from the call back interface
      participantType - : the type of participant, the user is searching for. User/AppRole/Group/All
      filter - : search query filter passed by the user to restrict the participants returned
      appId - : Optional Parameter. The appId the user is trying to search in, when the user searches for AppRole/All
      Returns:
      an IRestrictedAssignees object representing the permitted users set
      Throws:
      WorkflowException

    • getAttachment

      AttachmentType getAttachment(IWorkflowContext ctx, String taskId, String attachmentName) throws WorkflowException
      Parameters:
      ctx - The workflow context.
      taskId - The id of the task from where attachment needs to be downloaded
      attachmentName - The attachment name that needs to be downloaded. This attachment should have been added in this task
      Returns:
      The attachment object matching the given attachmentName from the given task
      Throws:
      WorkflowException

    • getSummaryFieldsInfoForTask

      TaskSummaryFieldsInfoResponse getSummaryFieldsInfoForTask(IWorkflowContext context, String taskId) throws WorkflowException
      Get Summary Field values for a specific Task by task Id. SummaryFieldsInfo provides actual values derived from Flelx Field mapping and/or data from Task standard field.
      Parameters:
      ctx - The workflow context IWorkflowContext.
      taskId - The id of the task
      Returns:
      SummaryFieldsInfo
      Throws:
      WorkflowException

    • getCommentsForTask

      List<CommentType> getCommentsForTask(IWorkflowContext ctx, String taskId) throws WorkflowException
      getCommentsForTask gets a list of comments entered by the previous assignees who took an action on the task identified by the given task Id
      Parameters:
      ctx - the workflow context.
      taskId - ID of task for which comments have to be fetched.
      Returns:
      a List of CommentType objects. Each CommentTYpe object contains the comment entered by a particular Assignee. UserID of the assignee who has entered the comment will be returned by the getUpdatedBy method of the object.
      Throws:
      WorkflowException - if any runtime error occurs while obtaining the list of comments.

    • isBPMQuiesced

      boolean isBPMQuiesced(IWorkflowContext ctx) throws WorkflowException
      isBPMQuiesced provides information is the task was triggered while SOA is in quiesce mdoe.
      Parameters:
      ctx - : the workflow context
      Throws:
      WorkflowException

    • getPersistedTaskSequence

      TaskSequence getPersistedTaskSequence(IWorkflowContext ctx, String taskId, List<String> taskDisplayColumns, List<ITaskQueryService.TaskSequenceType> taskSequenceType, List<ITaskQueryService.TaskSequenceBuilderContext> taskSequenceBuilderContext, boolean fetchTaskSequenceForRootTask, Set<ITaskQueryService.TaskSequenceFilterOptionalInfoType> optionalInfo) throws WorkflowException
       getPersistedTaskSequence gets the task sequence tree of a task whose id is taskId,
 for those type of sequence specified in sequenceTypes
 There are 4 types of objects in the returned tree. Each of these objects implement the ITaskSequence interface.
 
        
 
      1. TaskSequence. This node represents a sequence of nodes. 
 This node is always the root object and will also be the wrapper around a 
 parallel branch if there is more than one node in that branch. The 
 objects in the getChildren() method could be Parallel, SequenceGroup or 
 TaskSequenceRecord.
        2. 
 
      2. Parallel. This node represents a parallel events in the task. 
 Each node in the getChildren() method represents one parallel branch. The 
 objects in the getChildren() method could be Sequence, TaskSequenceGroup, 
 Parallel or TaskSequenceRecord. 
        3. 
 
      3. SequenceGroup. The SequenceGroup object represents a sequence 
 of nodes that are grouped because they belong to the same workflow 
 pattern like management chain or sequential participant. The objects 
 in the getChildren() method are always TaskSequenceRecord objects. By 
 default there will be no SequenceGroup objects.
        4. 
 
      4. TaskSequenceRecord. This object represents actual update to the 
 task or a future assignment. It doesn't have any children.
        5. 
 
      
 
        
 
      1. Supported only for STAGE or WORKFLOW_PATTERN TaskSequenceBuilderContext. Multiple values in list is not supported
        2. 
 
      
 Attributes in each of ITaskSequence objects are:
 
 
      
 
      
 Attribute
 TaskSequence
 Parallel
 SequenceGroup
 TaskSequenceRecord
 
      
 
      
 Id
 Not populated by default
 Not populated by default
 Not populated by default
 Not populated by default
 
      
 
      
 SequenceNumber
 Populated by default
 Populated by default
 Populated by default
 Populated by default
 
      
 
      
 Label
 Not applicable
 The name of the parallel pattern as specified during design time
 The name of the workflow pattern node as specified during design time
 The name of the workflow pattern node as specified during design time
 
      
 
      
 Pattern
 Not applicable
 ITaskSequence.Pattern.Parallel
 ITaskSequence.Pattern.ManagementChain or ITaskSequence.Pattern.SequentialParticipant
 ITaskSequence.Pattern.*
 
      
 
      
 Name
 Not applicable
 Same as label
 Same as label
 Concatenated string of the assignees
 
      
 
      
 FlexString1-5
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 Not populated by default. Available for clients to set additional attributes on nodes in the tree
 
      
 
      
 
 
 Note:
 
        
 
      1. None of the attributes are set on the root TaskSequence object.
        2. 
 
      
 
 Retrieving the task sequence with taskid
 The usage is shown below:
 
      ITaskQueryService querySvc = ...
      List<ITaskQueryService.TaskSequenceType> sequenceTypes =
          new ArrayList<ITaskQueryService.TaskSequenceType>();
      sequenceTypes.add(ITaskQueryService.TaskSequenceType.ALL);
 
      List<ITaskQueryService.TaskSequenceBuilderContext> taskSequenceBuilderContext =
          new ArrayList<ITaskQueryService.TaskSequenceBuilderContext>();
      taskSequenceBuilderContext.add(ITaskQueryService.TaskSequenceBuilderContext.STAGE);
 
      TaskSequence taskSequence =
          querySvc.getPersistedTaskSequence(ctx, taskId, null, sequenceTypes,
                                   taskSequenceBuilderContext, true, optionalInfo);

 
 
 
 Setting additional attributes on the retrieved task sequence
 It is often necessary for the clients to set other data on the task sequence before using it. For 
 example, the client might want to dispaly the task sequence in a table with some image hints 
 based on pattern. The following code illustrates use of the flex strings to do this:
 
    TaskSequence taskSequence = ...;
    setImage(taskSequence);
 
    private void setImage(ITaskSequence taskSequence) {
        ITaskSequence.Pattern pattern = taskSequence.getPattern();
        System.out.println(pattern);
        if (pattern == ITaskSequence.Pattern.ManagementChain) {
            taskSequence.setFlexString1("sequential.png");
        } else if (pattern == ITaskSequence.Pattern.Parallel) {
            taskSequence.setFlexString1("parallel.png");
        } else if (pattern == ITaskSequence.Pattern.Participant) {
            taskSequence.setFlexString1("user.png");
        } else if (pattern == ITaskSequence.Pattern.SequentialParticipant) {
            taskSequence.setFlexString1("sequential.png");
        }
 
        List children = taskSequence.getChildren();
        if (children != null) {
            for (int index = 0; index < children.size(); index++) {
                ITaskSequence taskSequenceChild =
                    (ITaskSequence)children.get(index);
                setImage(taskSequenceChild);
            }
        }
    }
 
 
 Setting additional attributes on the retrieved task sequence
 The following code shows how to create an ADF TreeModel from the task sequence
 
    List rootListNode = new ArrayList();
    rootListNode.addAll(taskSequence.getChildren());
    org.apache.myfaces.trinidad.model.TreeModel treeModel = new ChildPropertyTreeModel(rootListNode, "children");
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      task - the task whose details are needed
      taskDisplayColumns - the task columns to query
      taskSequenceType - a list containing type of task sequence type to be retrieved
      taskSequenceBuilderContext - : List containing context to the task sequence builder. Supported only for STAGE and WORKFLOW_PATTERN. If the value is INCLUDE_SEQUENCE_FOR_SINGLE_CHILD or if Multiple values are passed then unsupported operation exception is thrown.
      fetchTaskSequenceForRootTask - If true, get the task sequence for the root task, else get the task sequence for the current task. The root task is the main task which could have sub tasks that represent parallel tasks. Caching is done only if fetchTaskSequenceForRootTask is true. Cached Task Sequence is retrieved only if fetchTaskSequenceForRootTask is true. If fetchTaskSequenceForRootTask is false Task Sequence is recomputed
      optionalInfo - To get attachment, comments and flag to indicate system approval
      Returns:
      an TaskSequence object, which the represents the task sequence tree
      Throws:
      WorkflowException - if any runtime error occurs while getting task sequence

    • isAggregatedFyi

      boolean isAggregatedFyi(Task task) throws WorkflowException
      Throws:
      WorkflowException

    • getTasksByCategory

      List<Task> getTasksByCategory(IWorkflowContext ctx, String categoryCode, String subCategoryCode, int startRow, int endRow) throws WorkflowException
      getTasksByCategory gets the tasks based on the given categoryCode and subCategoryCode. CategoryCode is mandatory and subCategoryCode is optional to use this API. If both categoryCode and subCategoryCode values are given then an AND condition will be used. Added this API as part of the Taxonomy Project.
      Parameters:
      ctx -
      categoryCode -
      subCategoryCode -
      startRow -
      endRow -
      Returns:
      a list of matching Task objects
      Throws:
      WorkflowException

    • getTaskDetailsById

      Task getTaskDetailsById(IWorkflowContext ctx, String taskId, List<ITaskQueryService.OptionalInfo> optionalInformation) throws WorkflowException
      getTaskDetailsById gets the details of a task whose id is taskId
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskId - the id of the task whose details are needed
      optionalInformation - a list specifying optional information to be retrieved 
       Possible Values:
  List optionalInformation = new ArrayList();
  optionalInformation.add(OptionalInfo.ALL_ACTIONS);
  optionalInformation.add(OptionalInfo.GROUP_ACTIONS);
  optionalInformation.add(OptionalInfo.CUSTOM_ACTIONS);
  optionalInformation.add(OptionalInfo.SHORT_HISTORY);
  optionalInformation.add(OptionalInfo.ATTACHMENTS);
  optionalInformation.add(OptionalInfo.FLEXFIELD_MAPPINGS);
  optionalInformation.add(OptionalInfo.PAYLOAD);
  optionalInformation.add(OptionalInfo.COMMENTS);
  optionalInformation.add(OptionalInfo.DISPLAY_INFO);
  optionalInformation.add(OptionalInfo.ACTION_DISPLAY_NAME);
  optionalInformation.add(OptionalInfo.TASK_VIEW_CONTEXT);
  optionalInformation.add(OptionalInfo.IMAGE_URL);
  optionalInformation.add(OptionalInfo.COLLECTION_TARGET);
      If optionalInformation is null, then no addtional information will be retrieved. Check Enum OptionalInfo for more details
      Returns:
      an Task object
      Throws:
      WorkflowException - if any runtime error occurs while getting task details

    • getTask

      Task getTask(IWorkflowContext ctx, oracle.bpel.services.workflow.query.TaskIdentifier taskIdentifier, List<String> displayColumns, List<ITaskQueryService.OptionalInfo> optionalInfo) throws WorkflowException
      getTask - Fetches the task given its identifier
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskIdentifier - Unique Identifier of the task
      displayColumns - a list containing names of columns to be retrieved
      optionalInfo - a list specifying optional information to be retrieved. If optionalInformation is null or empty, then no addtional information will be retrieved. Check Enum OptionalInfo for more details
      Returns:
      an Task object
      Throws:
      WorkflowException - if no task is found if invalid taskIdentifier if any runtime error occurs while getting task details

    • getTaskActionsWithOptionalAttrs

      List<Task> getTaskActionsWithOptionalAttrs(IWorkflowContext ctx, List<oracle.bpel.services.workflow.query.TaskIdentifier> taskIdentifiers, Map<oracle.bpel.services.workflow.query.TaskIdentifier,ITaskQueryService.TaskActionsType> actions, Map<oracle.bpel.services.workflow.query.TaskIdentifier,List<ITaskQueryService.OptionalAttribute>> optAttrs) throws WorkflowException
      getTaskActionsWithOptionalAttrs - Fetches the task (with ONLY actions, displayInfo and taskDisplayUrl populated) given its identifier ***warning*** Besides the above fields taskId, taskNumber and identificationKey if available are populated ***warning*** All other fields in the returned task object will be null
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      taskIdentifiers - List of unique Identifiers of the tasks
      actions - a map containing task-identifier as key and actionType as value actionType should be one of ALL_ACTIONS, GROUP_ACTIONS and CUSTOM_ACTIONS if no actionType specified for a task-identifier then default is set to ALL_ACTIONS
      optAttrs - a map containing task-identifier as key and OptionalAttribute as value currently the only OptionalAttribute supported is 'WORKLIST_URL' when WORKLIST_URL is requested the API returns both the DisplayInfo complex struct as well as taskDisplayUrl
      Returns:
      an Task object
      Throws:
      WorkflowException - if no task is found if invalid taskIdentifier if any runtime error occurs while getting task details

    • getTasks

      List<Task> getTasks(IWorkflowContext ctx, Set<String> displayColumns, oracle.bpel.services.workflow.query.QueryContext queryContext) throws WorkflowException
      getTasks - Fetches the list of tasks for the given user and QueryContext The scope of this API is to query and retrieve tasks at the very high level. i.e Using very high level search attributes like task-definition, identification-key, state, application stripe/role etc. The API will return ONLY the root level tasks OR aggregated tasks OR root level and line level tasks and no other tasks in the approval flow For all other drill down cases we will provide separate APIs for them both for better design and performance
      Parameters:
      ctx - the workflow context (can contain valid token or credentials)
      displayColumns - a list containing names of columns to be retrieved
      queryContext - specify context for the query: queryAssignmentFilter - Assignment filter to be used for the query Currently only following is supported: MY GROUP MY_GROUP MY_GROUP_ALL OWNER CREATOR taskIdentifier - Structure with one of Enum constants TASK_DEFN_NAME, TASK_DEFN_ID and TASK_NAME_SPACE as key and list of strings as value taskSelector - Enum with constants ROOT_TASK_ONLY, AGGREGATED_TASKS ROOT_TASK_ONLY will only fetch root tasks AGGREGATED_TASKS will fetch aggregated tasks as well as tasks that cannot be aggregated for some reason ROOT_TASK_AND_SUB_TASKS_ONLY will return only the root tasks and the sub tasks (collection target instances) for each root task no other tasks taskIdentificationKeys - Only tasks from this list of task identification keys will be fetched applicationStripes - List of application stripes for this user to limit the application-role memebership for the query applicationRoles - List of application roles for this user to limit the application-role memebership for the query taskStates - Only tasks with STATE values from this list will be fetched. The supported task states are listed as an Enum. Enum TaskStatesEnum: "ALERTED" "ASSIGNED" "COMPLETED" "DELETED" "ERRORED" "EXPIRED" "INFO_REQUESTED" "OUTCOME_UPDATED" "STALE" "SUSPENDED" "WITHDRAWN" includeFYITasks - boolean to indicate if FYI tasks also should be fetched. Default is false - when this is true in conjunction with taskSelector=ROOT_TASK_ONLY all the matching root FYI tasks will also be returned - when this is true in conjunction with taskSelector=AGGREGATED_TASKS all the matching aggregated FYI tasks as well as matching FYI tasks that cannot be aggregated for some reason will also be returned startRow - start row of pagination endRow - end row of pagination localizeTasks - whether to translate the tasks are not. Default is false. Setting this to true will have a performance implication especially if _TL tables have lot of data taskOutcome (single value) a choice of the following two custom value OR Enum of APPROVE REJECT DEFER YES OK ACCEPT NO
      Returns:
      list of Task objects
      Throws:
      WorkflowException - if invalid queryContext if any runtime error occurs while fetching the task list

    • isFYITask

      boolean isFYITask(IWorkflowContext ctx, oracle.bpel.services.workflow.query.QueryContext.QueryAssignmentFilter queryAssignmentFilter, String taskId) throws WorkflowException
      Throws:
      WorkflowException

    • isAggregatedFYITask

      boolean isAggregatedFYITask(IWorkflowContext context, Task task) throws WorkflowException
      Throws:
      WorkflowException