public interface UserTaskAdminService
Modifier and Type | Method and 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 |
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 |
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 |
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.
|
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
|
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
|
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.
|
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 |
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 |
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 |
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 addPotentialOwners(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idremoveExisting
- specifies if existing potential owners should be removedorgEntities
- one or more potential owner to be added to a taskTaskNotFoundException
- thrown when there is no task with given idvoid addPotentialOwners(String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idremoveExisting
- specifies if existing potential owners should be removedorgEntities
- one or more potential owner to be added to a taskTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid addExcludedOwners(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idremoveExisting
- specifies if existing excluded owners should be removedorgEntities
- one or more excluded owner to be added to a taskTaskNotFoundException
- thrown when there is no task with given idvoid addExcludedOwners(String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idremoveExisting
- specifies if existing excluded owners should be removedorgEntities
- one or more excluded owner to be added to a taskTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid addBusinessAdmins(long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idremoveExisting
- specifies if existing business admins should be removedorgEntities
- one or more business admin to be added to a taskTaskNotFoundException
- thrown when there is no task with given idvoid addBusinessAdmins(String deploymentId, long taskId, boolean removeExisting, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idremoveExisting
- specifies if existing business admins should be removedorgEntities
- one or more business admin to be added to a taskTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid removePotentialOwners(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idorgEntities
- one or more potential owner to be removed from a taskTaskNotFoundException
- thrown when there is no task with given idvoid removePotentialOwners(String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idorgEntities
- one or more potential owner to be removed from a taskTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid removeExcludedOwners(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idorgEntities
- one or more excluded owner to be removed from a taskTaskNotFoundException
- thrown when there is no task with given idvoid removeExcludedOwners(String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idorgEntities
- one or more excluded owner to be removed from a taskTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid removeBusinessAdmins(long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException, IllegalStateException
taskId
- unique task idorgEntities
- one or more business admin to be removed from a taskTaskNotFoundException
- thrown when there is no task with given idIllegalStateException
- in case there are no business admins left on a task - there must be at least one business adminvoid removeBusinessAdmins(String deploymentId, long taskId, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException, IllegalStateException
deploymentId
- taskId
- unique task idorgEntities
- one or more business admin to be removed from a taskTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idIllegalStateException
- in case there are no business admins left on a task - there must be at least one business adminvoid addTaskInput(long taskId, String name, Object value) throws TaskNotFoundException
taskId
- unique task idname
- name of the input variable to be addedvalue
- value of the input variableTaskNotFoundException
- thrown when there is no task with given idvoid addTaskInput(String deploymentId, long taskId, String name, Object value) throws TaskNotFoundException
deploymentId
- taskId
- unique task idname
- name of the input variable to be addedvalue
- value of the input variableTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid addTaskInputs(long taskId, Map<String,Object> data) throws TaskNotFoundException
taskId
- unique task iddata
- map of key (name of the variable) and value (value of the variable)TaskNotFoundException
- thrown when there is no task with given idvoid addTaskInputs(String deploymentId, long taskId, Map<String,Object> data) throws TaskNotFoundException
deploymentId
- taskId
- unique task iddata
- map of key (name of the variable) and value (value of the variable)TaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid removeTaskInputs(long taskId, String... name) throws TaskNotFoundException
taskId
- unique task idname
- name(s) of the input variables to be removedTaskNotFoundException
- thrown when there is no task with given idvoid removeTaskInputs(String deploymentId, long taskId, String... name) throws TaskNotFoundException
deploymentId
- taskId
- unique task idname
- name(s) of the input variables to be removedTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid removeTaskOutputs(long taskId, String... name) throws TaskNotFoundException
taskId
- unique task idname
- name(s) of the output variables to be removedTaskNotFoundException
- thrown when there is no task with given idvoid removeTaskOutputs(String deploymentId, long taskId, String... name) throws TaskNotFoundException
deploymentId
- taskId
- unique task idname
- name(s) of the output variables to be removedTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idLong reassignWhenNotStarted(long taskId, String timeExpression, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dorgEntities
- users/groups that will be reassigned to after conditions are metTaskNotFoundException
- thrown when there is no task with given idLong reassignWhenNotStarted(String deploymentId, long taskId, String timeExpression, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dorgEntities
- users/groups that will be reassigned to after conditions are metTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idLong reassignWhenNotCompleted(long taskId, String timeExpression, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dorgEntities
- users/groups that will be reassigned to after conditions are metTaskNotFoundException
- thrown when there is no task with given idLong reassignWhenNotCompleted(String deploymentId, long taskId, String timeExpression, org.kie.api.task.model.OrganizationalEntity... orgEntities) throws TaskNotFoundException
deploymentId
- taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dorgEntities
- users/groups that will be reassigned to after conditions are metTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idLong notifyWhenNotStarted(long taskId, String timeExpression, org.kie.internal.task.api.model.Notification notification) throws TaskNotFoundException
taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dnotification
- actual notification to be sentTaskNotFoundException
- thrown when there is no task with given idLong notifyWhenNotStarted(String deploymentId, long taskId, String timeExpression, org.kie.internal.task.api.model.Notification notification) throws TaskNotFoundException
deploymentId
- taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dnotification
- actual notification to be sentTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idLong notifyWhenNotCompleted(long taskId, String timeExpression, org.kie.internal.task.api.model.Notification notification) throws TaskNotFoundException
taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dnotification
- actual notification to be sentTaskNotFoundException
- thrown when there is no task with given idLong notifyWhenNotCompleted(String deploymentId, long taskId, String timeExpression, org.kie.internal.task.api.model.Notification notification) throws TaskNotFoundException
deploymentId
- taskId
- unique task idtimeExpression
- time expression in duration format as 2s, 5h, 7dnotification
- actual notification to be sentTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idorg.kie.internal.task.api.model.EmailNotification buildEmailNotification(String subjectStr, List<org.kie.api.task.model.OrganizationalEntity> recipients, String bodyStr, String fromStr, String replyToStr)
subjectStr
- email subjectrecipients
- list of recipients to be included in the notification, must be at least onebodyStr
- email body, can reference task variablesfromStr
- user who sends the emailreplyToStr
- optional reply to addressCollection<TaskReassignment> getTaskReassignments(long taskId, boolean activeOnly) throws TaskNotFoundException
taskId
- unique task idactiveOnly
- determines if only active (not yet fired) should be returnedTaskNotFoundException
- thrown when there is no task with given idCollection<TaskReassignment> getTaskReassignments(String deploymentId, long taskId, boolean activeOnly) throws TaskNotFoundException
deploymentId
- taskId
- unique task idactiveOnly
- determines if only active (not yet fired) should be returnedTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idCollection<TaskNotification> getTaskNotifications(long taskId, boolean activeOnly) throws TaskNotFoundException
taskId
- unique task idactiveOnly
- determines if only active (not yet fired) should be returnedTaskNotFoundException
- thrown when there is no task with given idCollection<TaskNotification> getTaskNotifications(String deploymentId, long taskId, boolean activeOnly) throws TaskNotFoundException
deploymentId
- taskId
- unique task idactiveOnly
- determines if only active (not yet fired) should be returnedTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid cancelNotification(long taskId, long notificationId) throws TaskNotFoundException
taskId
- unique task idnotificationId
- unique notification idTaskNotFoundException
- thrown when there is no task with given idvoid cancelNotification(String deploymentId, long taskId, long notificationId) throws TaskNotFoundException
deploymentId
- taskId
- unique task idnotificationId
- unique notification idTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idvoid cancelReassignment(long taskId, long reassignmentId) throws TaskNotFoundException
taskId
- unique task idreassignmentId
- unique reassignment idTaskNotFoundException
- thrown when there is no task with given idvoid cancelReassignment(String deploymentId, long taskId, long reassignmentId) throws TaskNotFoundException
deploymentId
- taskId
- unique task idreassignmentId
- unique reassignment idTaskNotFoundException
- thrown when there is no task with given id or is not associated with given deployment idList<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskId(long taskId, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
taskId
- unique task idincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationList<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName(String taskName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
taskName
- name of the taskincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationList<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName(String processId, String taskName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
processId
- process id of the process that task belongs totaskName
- name of the taskincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationList<org.kie.internal.runtime.error.ExecutionError> getErrorsByTaskName(String deploymentId, String processId, String taskName, boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
deploymentId
- deployment id that contains given processprocessId
- process id of the process that task belongs totaskName
- name of the taskincludeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationvoid acknowledgeError(String... errorId) throws ExecutionErrorNotFoundException
errorId
- unique id of the errorExecutionErrorNotFoundException
- thrown when there is no unacknowledged error with that idorg.kie.internal.runtime.error.ExecutionError getError(String errorId) throws ExecutionErrorNotFoundException
errorId
- unique id of the errorExecutionErrorNotFoundException
- is thrown in case no error was found for given error idList<org.kie.internal.runtime.error.ExecutionError> getErrors(boolean includeAcknowledged, org.kie.api.runtime.query.QueryContext queryContext)
includeAcknowledged
- indicates whether to include acknowledged errors or notqueryContext
- control parameters for paginationCopyright © 2001–2018 JBoss by Red Hat. All rights reserved.