Class UserTaskAdminServiceImpl

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ADMIN  
      static int EXCL_OWNER  
      static int POT_OWNER  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void acknowledgeError​(String... errorId)
      Acknowledge given error that it was reviewed and understood
      void addBusinessAdmins​(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Adds new business admin for a given task.
      void addBusinessAdmins​(String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Adds new business admin for a given task.
      void addBusinessAdmins​(String userId, String deploymentId, 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 addExcludedOwners​(String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Adds new excluded owners for a given task.
      void addExcludedOwners​(String userId, String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Adds new excluded owners for a given task.
      protected void addPeopleAssignment​(String deploymentId, long taskId, boolean removeExisting, int type, org.kie.api.task.model.OrganizationalEntity... orgEntities)  
      protected void addPeopleAssignment​(String userId, String deploymentId, long taskId, boolean removeExisting, int type, org.kie.api.task.model.OrganizationalEntity... orgEntities)  
      void addPotentialOwners​(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Adds new potential owners for a given task.
      void addPotentialOwners​(String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Adds new potential owners for a given task.
      void addPotentialOwners​(String userId, String deploymentId, 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 addTaskInput​(String deploymentId, 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.
      void addTaskInputs​(String deploymentId, long taskId, Map<String,​Object> data)
      Adds new items to task input variables.
      protected void applyQueryContext​(Map<String,​Object> params, org.kie.api.runtime.query.QueryContext queryContext)  
      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 cancelNotification​(String deploymentId, long taskId, long notificationId)
      Cancels given notification on a task
      void cancelReassignment​(long taskId, long reassignmentId)
      Cancels given reassignment on a task
      void cancelReassignment​(String deploymentId, long taskId, long reassignmentId)
      Cancels given reassignment on a task
      protected List<Short> getAckMode​(boolean includeAcknowledged)  
      org.kie.internal.runtime.error.ExecutionError getError​(String errorId)
      Returns execution error identified by given error id
      List<org.kie.internal.runtime.error.ExecutionError> getErrors​(boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
      Returns execution errors that are classified as task type errors
      List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskId​(long taskId, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
      Returns execution errors for given task id
      List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName​(String taskName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
      Returns execution errors for given task name
      List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName​(String processId, String taskName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
      Returns execution errors for given task name and process id
      List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName​(String deploymentId, String processId, String taskName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
      Returns execution errors for given task name, process id and deployment id
      Collection<TaskNotification> getTaskNotifications​(long taskId, boolean activeOnly)
      Returns task notifications scheduled for given task
      Collection<TaskNotification> getTaskNotifications​(String deploymentId, 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
      Collection<TaskReassignment> getTaskReassignments​(String deploymentId, long taskId, boolean activeOnly)
      Returns task reassignments scheduled for given task
      protected Long notify​(String deploymentId, long taskId, String timeExpression, org.kie.internal.task.api.TaskDeadlinesService.DeadlineType type, org.kie.internal.task.api.model.Notification notification)  
      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 notifyWhenNotCompleted​(String deploymentId, 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 notifyWhenNotStarted​(String deploymentId, 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.
      protected Long reassign​(String deploymentId, long taskId, String timeExpression, org.kie.internal.task.api.TaskDeadlinesService.DeadlineType type, org.kie.api.task.model.OrganizationalEntity... orgEntities)  
      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 reassignWhenNotCompleted​(String deploymentId, 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.
      Long reassignWhenNotStarted​(String deploymentId, 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 removeBusinessAdmins​(String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Remove existing business admin from given task.
      void removeBusinessAdmins​(String userId, String deploymentId, 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 removeExcludedOwners​(String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Remove existing excluded owners from given task.
      void removeExcludedOwners​(String userId, String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Remove existing excluded owners from given task.
      protected void removePeopleAssignment​(String deploymentId, long taskId, int type, org.kie.api.task.model.OrganizationalEntity... orgEntities)  
      protected void removePeopleAssignment​(String userId, String deploymentId, long taskId, int type, org.kie.api.task.model.OrganizationalEntity... orgEntities)  
      void removePotentialOwners​(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Remove existing potential owners from given task.
      void removePotentialOwners​(String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities)
      Remove existing potential owners from given task.
      void removePotentialOwners​(String userId, String deploymentId, 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 removeTaskInputs​(String deploymentId, 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.
      void removeTaskOutputs​(String deploymentId, long taskId, String... name)
      Removes one or more output variables from a task.
      void setCommandService​(TransactionalCommandService commandService)  
      void setIdentityProvider​(org.kie.internal.identity.IdentityProvider identityProvider)  
      void setRuntimeDataService​(RuntimeDataService runtimeDataService)  
      void setUserTaskService​(UserTaskService userTaskService)  
      protected void validateTask​(String deploymentId, Long taskId, UserTaskInstanceDesc task)  
    • Constructor Detail

      • UserTaskAdminServiceImpl

        public UserTaskAdminServiceImpl()
    • Method Detail

      • setUserTaskService

        public void setUserTaskService​(UserTaskService userTaskService)
      • setRuntimeDataService

        public void setRuntimeDataService​(RuntimeDataService runtimeDataService)
      • setIdentityProvider

        public void setIdentityProvider​(org.kie.internal.identity.IdentityProvider identityProvider)
      • addPotentialOwners

        public void addPotentialOwners​(long taskId,
                                       boolean removeExisting,
                                       org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        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.
        Specified by:
        addPotentialOwners in interface UserTaskAdminService
        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
      • addPotentialOwners

        public void addPotentialOwners​(String deploymentId,
                                       long taskId,
                                       boolean removeExisting,
                                       org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        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.
        Specified by:
        addPotentialOwners in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • addPotentialOwners

        public void addPotentialOwners​(String userId,
                                       String deploymentId,
                                       long taskId,
                                       boolean removeExisting,
                                       org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        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.
        Specified by:
        addPotentialOwners in interface UserTaskAdminService
        Parameters:
        userId - user doing the update
        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 or is not associated with given deployment id
      • addExcludedOwners

        public void addExcludedOwners​(long taskId,
                                      boolean removeExisting,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Adds new excluded owners for a given task. Can be instructed to remove existing excluded owners. Task must be in active state.
        Specified by:
        addExcludedOwners in interface UserTaskAdminService
        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
      • addExcludedOwners

        public void addExcludedOwners​(String deploymentId,
                                      long taskId,
                                      boolean removeExisting,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Adds new excluded owners for a given task. Can be instructed to remove existing excluded owners. Task must be in active state.
        Specified by:
        addExcludedOwners in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • addExcludedOwners

        public void addExcludedOwners​(String userId,
                                      String deploymentId,
                                      long taskId,
                                      boolean removeExisting,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Adds new excluded owners for a given task. Can be instructed to remove existing excluded owners. Task must be in active state.
        Specified by:
        addExcludedOwners in interface UserTaskAdminService
        Parameters:
        userId - user doing the update
        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 or is not associated with given deployment id
      • addBusinessAdmins

        public void addBusinessAdmins​(long taskId,
                                      boolean removeExisting,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Adds new business admin for a given task. Can be instructed to remove existing business admins. Task must be in active state.
        Specified by:
        addBusinessAdmins in interface UserTaskAdminService
        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
      • addBusinessAdmins

        public void addBusinessAdmins​(String deploymentId,
                                      long taskId,
                                      boolean removeExisting,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Adds new business admin for a given task. Can be instructed to remove existing business admins. Task must be in active state.
        Specified by:
        addBusinessAdmins in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • addBusinessAdmins

        public void addBusinessAdmins​(String userId,
                                      String deploymentId,
                                      long taskId,
                                      boolean removeExisting,
                                      org.kie.api.task.model.OrganizationalEntity... orgEntities)
                               throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Adds new business admin for a given task. Can be instructed to remove existing business admins. Task must be in active state.
        Specified by:
        addBusinessAdmins in interface UserTaskAdminService
        Parameters:
        userId - user doing the update
        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 or is not associated with given deployment id
      • removePotentialOwners

        public void removePotentialOwners​(long taskId,
                                          org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                   throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Remove existing potential owners from given task. Task must be in active state.
        Specified by:
        removePotentialOwners in interface UserTaskAdminService
        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
      • removePotentialOwners

        public void removePotentialOwners​(String userId,
                                          String deploymentId,
                                          long taskId,
                                          org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                   throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Remove existing potential owners from given task. Task must be in active state.
        Specified by:
        removePotentialOwners in interface UserTaskAdminService
        Parameters:
        userId - user doing the update
        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 or is not associated with given deployment id
      • removePotentialOwners

        public void removePotentialOwners​(String deploymentId,
                                          long taskId,
                                          org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                   throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Remove existing potential owners from given task. Task must be in active state.
        Specified by:
        removePotentialOwners in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • removeExcludedOwners

        public void removeExcludedOwners​(long taskId,
                                         org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                  throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Remove existing excluded owners from given task. Task must be in active state.
        Specified by:
        removeExcludedOwners in interface UserTaskAdminService
        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
      • removeExcludedOwners

        public void removeExcludedOwners​(String userId,
                                         String deploymentId,
                                         long taskId,
                                         org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                  throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Remove existing excluded owners from given task. Task must be in active state.
        Specified by:
        removeExcludedOwners in interface UserTaskAdminService
        Parameters:
        userId - user doing the update
        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 or is not associated with given deployment id
      • removeExcludedOwners

        public void removeExcludedOwners​(String deploymentId,
                                         long taskId,
                                         org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                  throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Remove existing excluded owners from given task. Task must be in active state.
        Specified by:
        removeExcludedOwners in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • removeBusinessAdmins

        public void removeBusinessAdmins​(String userId,
                                         String deploymentId,
                                         long taskId,
                                         org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                  throws TaskNotFoundException,
                                         IllegalStateException
        Description copied from interface: UserTaskAdminService
        Remove existing business admin from given task. Task must be in active state.
        Specified by:
        removeBusinessAdmins in interface UserTaskAdminService
        Parameters:
        userId - user doing the update
        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 or is not associated with given deployment id
        IllegalStateException - in case there are no business admins left on a task - there must be at least one business admin
      • reassignWhenNotStarted

        public Long reassignWhenNotStarted​(long taskId,
                                           String timeExpression,
                                           org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                    throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Reassign automatically a task in case it was not started before time given as timeExpression elapses.
        Specified by:
        reassignWhenNotStarted in interface UserTaskAdminService
        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
      • reassignWhenNotStarted

        public Long reassignWhenNotStarted​(String deploymentId,
                                           long taskId,
                                           String timeExpression,
                                           org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                    throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Reassign automatically a task in case it was not started before time given as timeExpression elapses.
        Specified by:
        reassignWhenNotStarted in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • reassignWhenNotCompleted

        public Long reassignWhenNotCompleted​(long taskId,
                                             String timeExpression,
                                             org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                      throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Reassign automatically a task in case it was not completed before time given as timeExpression elapses.
        Specified by:
        reassignWhenNotCompleted in interface UserTaskAdminService
        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

        public Long reassignWhenNotCompleted​(String deploymentId,
                                             long taskId,
                                             String timeExpression,
                                             org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                      throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Reassign automatically a task in case it was not completed before time given as timeExpression elapses.
        Specified by:
        reassignWhenNotCompleted in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • notifyWhenNotStarted

        public Long notifyWhenNotStarted​(long taskId,
                                         String timeExpression,
                                         org.kie.internal.task.api.model.Notification notification)
                                  throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Sends notification (of notification type) to given recipients in case task was not started before time given as timeExpression elapses.
        Specified by:
        notifyWhenNotStarted in interface UserTaskAdminService
        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
      • notifyWhenNotStarted

        public Long notifyWhenNotStarted​(String deploymentId,
                                         long taskId,
                                         String timeExpression,
                                         org.kie.internal.task.api.model.Notification notification)
                                  throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Sends notification (of notification type) to given recipients in case task was not started before time given as timeExpression elapses.
        Specified by:
        notifyWhenNotStarted in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • notifyWhenNotCompleted

        public Long notifyWhenNotCompleted​(long taskId,
                                           String timeExpression,
                                           org.kie.internal.task.api.model.Notification notification)
                                    throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Sends notification (of notification type) to given recipients in case task was not completed before time given as timeExpression elapses.
        Specified by:
        notifyWhenNotCompleted in interface UserTaskAdminService
        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

        public Long notifyWhenNotCompleted​(String deploymentId,
                                           long taskId,
                                           String timeExpression,
                                           org.kie.internal.task.api.model.Notification notification)
                                    throws TaskNotFoundException
        Description copied from interface: UserTaskAdminService
        Sends notification (of notification type) to given recipients in case task was not completed before time given as timeExpression elapses.
        Specified by:
        notifyWhenNotCompleted in interface UserTaskAdminService
        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 or is not associated with given deployment id
      • buildEmailNotification

        public org.kie.internal.task.api.model.EmailNotification buildEmailNotification​(String subjectStr,
                                                                                        List<org.kie.api.task.model.OrganizationalEntity> recipients,
                                                                                        String bodyStr,
                                                                                        String fromStr,
                                                                                        String replyToStr)
        Description copied from interface: UserTaskAdminService
        Builds email notification based on given parameters that can be used as argument for notifyWhenNotStarted and notifyWhenNotCompleted methods
        Specified by:
        buildEmailNotification in interface UserTaskAdminService
        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
      • getErrors

        public List<org.kie.internal.runtime.error.ExecutionError> getErrors​(boolean includeAcknowledged,
                                                                             org.kie.api.runtime.query.QueryContext queryContext)
        Description copied from interface: UserTaskAdminService
        Returns execution errors that are classified as task type errors
        Specified by:
        getErrors in interface UserTaskAdminService
        Parameters:
        includeAcknowledged - indicates whether to include acknowledged errors or not
        queryContext - control parameters for pagination
        Returns:
        list of found errors
      • getErrorsByTaskId

        public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskId​(long taskId,
                                                                                     boolean includeAcknowledged,
                                                                                     org.kie.api.runtime.query.QueryContext queryContext)
        Description copied from interface: UserTaskAdminService
        Returns execution errors for given task id
        Specified by:
        getErrorsByTaskId in interface UserTaskAdminService
        Parameters:
        taskId - unique task id
        includeAcknowledged - indicates whether to include acknowledged errors or not
        queryContext - control parameters for pagination
        Returns:
        list of found errors
      • getErrorsByTaskName

        public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName​(String taskName,
                                                                                       boolean includeAcknowledged,
                                                                                       org.kie.api.runtime.query.QueryContext queryContext)
        Description copied from interface: UserTaskAdminService
        Returns execution errors for given task name
        Specified by:
        getErrorsByTaskName in interface UserTaskAdminService
        Parameters:
        taskName - name of the task
        includeAcknowledged - indicates whether to include acknowledged errors or not
        queryContext - control parameters for pagination
        Returns:
        list of found errors
      • getErrorsByTaskName

        public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName​(String processId,
                                                                                       String taskName,
                                                                                       boolean includeAcknowledged,
                                                                                       org.kie.api.runtime.query.QueryContext queryContext)
        Description copied from interface: UserTaskAdminService
        Returns execution errors for given task name and process id
        Specified by:
        getErrorsByTaskName in interface UserTaskAdminService
        Parameters:
        processId - process id of the process that task belongs to
        taskName - name of the task
        includeAcknowledged - indicates whether to include acknowledged errors or not
        queryContext - control parameters for pagination
        Returns:
        list of found errors
      • getErrorsByTaskName

        public List<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName​(String deploymentId,
                                                                                       String processId,
                                                                                       String taskName,
                                                                                       boolean includeAcknowledged,
                                                                                       org.kie.api.runtime.query.QueryContext queryContext)
        Description copied from interface: UserTaskAdminService
        Returns execution errors for given task name, process id and deployment id
        Specified by:
        getErrorsByTaskName in interface UserTaskAdminService
        Parameters:
        deploymentId - deployment id that contains given process
        processId - process id of the process that task belongs to
        taskName - name of the task
        includeAcknowledged - indicates whether to include acknowledged errors or not
        queryContext - control parameters for pagination
        Returns:
        list of found errors
      • addPeopleAssignment

        protected void addPeopleAssignment​(String deploymentId,
                                           long taskId,
                                           boolean removeExisting,
                                           int type,
                                           org.kie.api.task.model.OrganizationalEntity... orgEntities)
                                    throws TaskNotFoundException
        Throws:
        TaskNotFoundException
      • applyQueryContext

        protected void applyQueryContext​(Map<String,​Object> params,
                                         org.kie.api.runtime.query.QueryContext queryContext)
      • getAckMode

        protected List<Short> getAckMode​(boolean includeAcknowledged)