org.jbpm.services.api.admin

## Interface UserTaskAdminService

- All Known Implementing Classes:
    UserTaskAdminServiceImpl

      public interface UserTaskAdminService

  Provides administrative operations on top of active tasks. All operations should be performed by eligible user - in most of the case business administrator.

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addBusinessAdmins(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Adds new business admin for a given task.
    `void` | `addExcludedOwners(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Adds new excluded owners for a given task.
    `void` | `addPotentialOwners(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Adds new potential owners for a given task.
    `void` | `addTaskInput(long taskId, String name, Object value)` Adds new item to task input variables.
    `void` | `addTaskInputs(long taskId, Map<String,Object> data)` Adds new items to task input variables.
    `org.kie.internal.task.api.model.EmailNotification` | `buildEmailNotification(String subjectStr, List<org.kie.api.task.model.OrganizationalEntity> recipients, String bodyStr, String fromStr, String replyToStr)` Builds email notification based on given parameters that can be used as argument for notifyWhenNotStarted and notifyWhenNotCompleted methods
    `void` | `cancelNotification(long taskId, long notificationId)` Cancels given notification on a task
    `void` | `cancelReassignment(long taskId, long reassignmentId)` Cancels given reassignment on a task
    `Collection<TaskNotification>` | `getTaskNotifications(long taskId, boolean activeOnly)` Returns task notifications scheduled for given task
    `Collection<TaskReassignment>` | `getTaskReassignments(long taskId, boolean activeOnly)` Returns task reassignments scheduled for given task
    `Long` | `notifyWhenNotCompleted(long taskId, String timeExpression, org.kie.internal.task.api.model.Notification notification)` Sends notification (of notification type) to given recipients in case task was not completed before time given as timeExpression elapses.
    `Long` | `notifyWhenNotStarted(long taskId, String timeExpression, org.kie.internal.task.api.model.Notification notification)` Sends notification (of notification type) to given recipients in case task was not started before time given as timeExpression elapses.
    `Long` | `reassignWhenNotCompleted(long taskId, String timeExpression, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Reassign automatically a task in case it was not completed before time given as timeExpression elapses.
    `Long` | `reassignWhenNotStarted(long taskId, String timeExpression, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Reassign automatically a task in case it was not started before time given as timeExpression elapses.
    `void` | `removeBusinessAdmins(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Remove existing business admin from given task.
    `void` | `removeExcludedOwners(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Remove existing excluded owners from given task.
    `void` | `removePotentialOwners(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)` Remove existing potential owners from given task.
    `void` | `removeTaskInputs(long taskId, String... name)` Removes one or more input variables from a task.
    `void` | `removeTaskOutputs(long taskId, String... name)` Removes one or more output variables from a task.

- - ### Method Detail

    - #### addPotentialOwners

          void addPotentialOwners(long taskId,
                                  boolean removeExisting,
                                  org.kie.api.task.model.OrganizationalEntity... orgEntities)
                           throws TaskNotFoundException

      Adds new potential owners for a given task. Can be instructed to remove existing potential owners which means that the task will be released in case it was claimed already. Task must be in active state.
      Parameters:
        `taskId` - unique task id
        `removeExisting` - specifies if existing potential owners should be removed
        `orgEntities` - one or more potential owner to be added to a task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### addExcludedOwners

          void addExcludedOwners(long taskId,
                                 boolean removeExisting,
                                 org.kie.api.task.model.OrganizationalEntity... orgEntities)
                          throws TaskNotFoundException

      Adds new excluded owners for a given task. Can be instructed to remove existing excluded owners. Task must be in active state.
      Parameters:
        `taskId` - unique task id
        `removeExisting` - specifies if existing excluded owners should be removed
        `orgEntities` - one or more excluded owner to be added to a task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### addBusinessAdmins

          void addBusinessAdmins(long taskId,
                                 boolean removeExisting,
                                 org.kie.api.task.model.OrganizationalEntity... orgEntities)
                          throws TaskNotFoundException

      Adds new business admin for a given task. Can be instructed to remove existing business admins. Task must be in active state.
      Parameters:
        `taskId` - unique task id
        `removeExisting` - specifies if existing business admins should be removed
        `orgEntities` - one or more business admin to be added to a task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### removePotentialOwners

          void removePotentialOwners(long taskId,
                                     org.kie.api.task.model.OrganizationalEntity... orgEntities)
                              throws TaskNotFoundException

      Remove existing potential owners from given task. Task must be in active state.
      Parameters:
        `taskId` - unique task id
        `orgEntities` - one or more potential owner to be removed from a task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### removeExcludedOwners

          void removeExcludedOwners(long taskId,
                                    org.kie.api.task.model.OrganizationalEntity... orgEntities)
                             throws TaskNotFoundException

      Remove existing excluded owners from given task. Task must be in active state.
      Parameters:
        `taskId` - unique task id
        `orgEntities` - one or more excluded owner to be removed from a task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### removeBusinessAdmins

          void removeBusinessAdmins(long taskId,
                                    org.kie.api.task.model.OrganizationalEntity... orgEntities)
                             throws TaskNotFoundException,
                                    IllegalStateException

      Remove existing business admin from given task. Task must be in active state.
      Parameters:
        `taskId` - unique task id
        `orgEntities` - one or more business admin to be removed from a task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id
        `IllegalStateException` - in case there are no business admins left on a task - there must be at least one business admin

    - #### addTaskInput

          void addTaskInput(long taskId,
                            String name,
                            Object value)
                     throws TaskNotFoundException

      Adds new item to task input variables.
      Parameters:
        `taskId` - unique task id
        `name` - name of the input variable to be added
        `value` - value of the input variable
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### addTaskInputs

          void addTaskInputs(long taskId,
                             Map<String,Object> data)
                      throws TaskNotFoundException

      Adds new items to task input variables.
      Parameters:
        `taskId` - unique task id
        `data` - map of key (name of the variable) and value (value of the variable)
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### removeTaskInputs

          void removeTaskInputs(long taskId,
                                String... name)
                         throws TaskNotFoundException

      Removes one or more input variables from a task.
      Parameters:
        `taskId` - unique task id
        `name` - name(s) of the input variables to be removed
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### removeTaskOutputs

          void removeTaskOutputs(long taskId,
                                 String... name)
                          throws TaskNotFoundException

      Removes one or more output variables from a task.
      Parameters:
        `taskId` - unique task id
        `name` - name(s) of the output variables to be removed
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### reassignWhenNotStarted

          Long reassignWhenNotStarted(long taskId,
                                      String timeExpression,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException

      Reassign automatically a task in case it was not started before time given as timeExpression elapses.
      Parameters:
        `taskId` - unique task id
        `timeExpression` - time expression in duration format as 2s, 5h, 7d
        `orgEntities` - users/groups that will be reassigned to after conditions are met
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### reassignWhenNotCompleted

          Long reassignWhenNotCompleted(long taskId,
                                        String timeExpression,
                                        org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                 throws TaskNotFoundException

      Reassign automatically a task in case it was not completed before time given as timeExpression elapses.
      Parameters:
        `taskId` - unique task id
        `timeExpression` - time expression in duration format as 2s, 5h, 7d
        `orgEntities` - users/groups that will be reassigned to after conditions are met
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### notifyWhenNotStarted

          Long notifyWhenNotStarted(long taskId,
                                    String timeExpression,
                                    org.kie.internal.task.api.model.Notification notification)
                             throws TaskNotFoundException

      Sends notification (of notification type) to given recipients in case task was not started before time given as timeExpression elapses.
      Parameters:
        `taskId` - unique task id
        `timeExpression` - time expression in duration format as 2s, 5h, 7d
        `notification` - actual notification to be sent
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### notifyWhenNotCompleted

          Long notifyWhenNotCompleted(long taskId,
                                      String timeExpression,
                                      org.kie.internal.task.api.model.Notification notification)
                               throws TaskNotFoundException

      Sends notification (of notification type) to given recipients in case task was not completed before time given as timeExpression elapses.
      Parameters:
        `taskId` - unique task id
        `timeExpression` - time expression in duration format as 2s, 5h, 7d
        `notification` - actual notification to be sent
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### buildEmailNotification

          org.kie.internal.task.api.model.EmailNotification buildEmailNotification(String subjectStr,
                                                                                   List<org.kie.api.task.model.OrganizationalEntity> recipients,
                                                                                   String bodyStr,
                                                                                   String fromStr,
                                                                                   String replyToStr)

      Builds email notification based on given parameters that can be used as argument for notifyWhenNotStarted and notifyWhenNotCompleted methods
      Parameters:
        `subjectStr` - email subject
        `recipients` - list of recipients to be included in the notification, must be at least one
        `bodyStr` - email body, can reference task variables
        `fromStr` - user who sends the email
        `replyToStr` - optional reply to address
      Returns:
        completely configured email notification instance

    - #### getTaskReassignments

          Collection<TaskReassignment> getTaskReassignments(long taskId,
                                                            boolean activeOnly)
                                                     throws TaskNotFoundException

      Returns task reassignments scheduled for given task
      Parameters:
        `taskId` - unique task id
        `activeOnly` - determines if only active (not yet fired) should be returned
      Returns:
        returns list of task reassignments for given task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### getTaskNotifications

          Collection<TaskNotification> getTaskNotifications(long taskId,
                                                            boolean activeOnly)
                                                     throws TaskNotFoundException

      Returns task notifications scheduled for given task
      Parameters:
        `taskId` - unique task id
        `activeOnly` - determines if only active (not yet fired) should be returned
      Returns:
        returns list of task notifications for given task
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### cancelNotification

          void cancelNotification(long taskId,
                                  long notificationId)
                           throws TaskNotFoundException

      Cancels given notification on a task
      Parameters:
        `taskId` - unique task id
        `notificationId` - unique notification id
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

    - #### cancelReassignment

          void cancelReassignment(long taskId,
                                  long reassignmentId)
                           throws TaskNotFoundException

      Cancels given reassignment on a task
      Parameters:
        `taskId` - unique task id
        `reassignmentId` - unique reassignment id
      Throws:
        `TaskNotFoundException` - thrown when there is no task with given id

Copyright © 2001–2017 JBoss by Red Hat. All rights reserved.