public interface ITaskServiceProvider
Modifier and Type | Method and Description |
---|---|
void |
acceptTask(ITaskInfo taskInfo)
Accepts the task as current user.
|
void |
addTaskAuditRecord(String taskID,
int operation,
String sourceID,
Map<String,?> properties)
Adds a records to task audit log
|
boolean |
canUser(String taskID,
String accessRight)
Checks if user has rights to execute action on the task
|
void |
delegateTask(String taskID,
String[] fromUserID,
String[] toUserID,
boolean overwriteExisting)
Delegate a task from one set of users to another set.
|
void |
deleteTask(String taskID)
Stops and deletes task
|
ITaskInfo |
getCurrentTask() |
String |
getCurrentUserID() |
String |
getDelegatedBy(String userID,
String taskID)
Returns ID of the principal who delegated this task to the current user or null if
task was not delegated
|
String |
getProcessDeployVersion(String processInstanceID)
Retrieves deployVersion for process instance ID.
|
ITaskAudit[] |
getTaskAudit(String taskID) |
ITaskData |
getTaskData(String taskID)
Returns task data by given taskID
|
ITaskInfo |
getTaskInfo(String taskID)
Returns task info by given taskID.
|
String |
getTaskTypeID(String taskID) |
String |
getTaskTypeName(String taskTypeID) |
boolean |
isProcessArchived(String processID)
Checks ProcessAudit database for presence of given process instance
|
boolean |
isThresholdReached(String taskID)
Returns true if the task can transition to the next status based on a threshold,
otherwise returns false.
|
String |
queueNewTask(String taskTypeID,
ITaskInfo taskInfo,
ITaskData taskData)
Queues new task using specified task type ID
|
void |
removeTaskVotes(String taskID)
Clears all the votes for the task.
|
void |
rollbackTask(String taskID,
String auditID)
Rollsback a task to the specified audit ID
|
ITask[] |
searchAllTasks(TaskSearchQuery taskQuery,
boolean includeTaskData)
Searches all tasks
|
List<ITaskSearchRecord> |
searchAllTasksPaged(TaskSearchQueryV2 taskQuery,
boolean businessData)
Searches all tasks and return the result as pageable list
|
int |
searchAllTasksTotalCount(TaskSearchQueryV2 taskQuery,
boolean businessData)
Searches all tasks and return total count
|
ITask[] |
searchUserTasks(TaskSearchQuery taskQuery,
boolean includeTaskData)
Searches user inbox tasks
|
List<ITaskSearchRecord> |
searchUserTasksPaged(TaskSearchQueryV2 taskQuery,
boolean businessData)
Searches all tasks in user inbox
|
int |
searchUserTasksTotalCount(TaskSearchQueryV2 taskQuery,
boolean businessData)
Searches all tasks in user inbox and return the total count
|
void |
setDefaultMonitorISConfig()
Sets IS configuration for Monitor to default server.
|
void |
unacceptTask(ITaskInfo taskInfo)
Unaccepts the task as current user.
|
void |
updateTask(ITaskInfo taskInfo,
ITaskData taskData)
Updates task
|
void |
voteTask(String taskID,
String status)
Vote for a task with a status of choice.
|
ITask[] searchAllTasks(TaskSearchQuery taskQuery, boolean includeTaskData) throws Exception
taskQuery
- specifies the search criteriaincludeTaskData
- indicates whether the search result should return task data or notException
ITask[] searchUserTasks(TaskSearchQuery taskQuery, boolean includeTaskData) throws Exception
taskQuery
- specifies the search criteriaincludeTaskData
- indicates whether the search result should return task data or notException
ITaskInfo getTaskInfo(String taskID) throws Exception
taskID
- Exception
ITaskData getTaskData(String taskID) throws Exception
taskID
- Exception
String queueNewTask(String taskTypeID, ITaskInfo taskInfo, ITaskData taskData) throws Exception
taskTypeID
- taskInfo
- taskData
- Exception
void updateTask(ITaskInfo taskInfo, ITaskData taskData) throws Exception
taskInfo
- taskData
- Exception
void acceptTask(ITaskInfo taskInfo) throws Exception
taskInfo
- Exception
void unacceptTask(ITaskInfo taskInfo) throws Exception
taskInfo
- Exception
void deleteTask(String taskID) throws Exception
taskInfo
- Exception
String getCurrentUserID() throws Exception
Exception
String getTaskTypeID(String taskID) throws Exception
Exception
String getTaskTypeName(String taskTypeID) throws Exception
Exception
boolean canUser(String taskID, String accessRight) throws Exception
taskID
- accessRight
- Exception
String getDelegatedBy(String userID, String taskID) throws Exception
userID
- taskID
- Exception
void delegateTask(String taskID, String[] fromUserID, String[] toUserID, boolean overwriteExisting) throws Exception
taskID
- - ID of the task to delegatefromUserID
- - Array of principal UIDs as String[] to delegate fromtoUserID
- - Array of principal UIDs as String[] to delegate tooverwriteExisting
- - true to clear the existing delegation list, otherwise append new entriesException
ITaskAudit[] getTaskAudit(String taskID) throws Exception
taskID
- Exception
void addTaskAuditRecord(String taskID, int operation, String sourceID, Map<String,?> properties) throws Exception
taskID
- taskID to add audit record tooperation
- audit record operationsourceID
- source identifier (may be null)properties
- audit properties (may be null)Exception
void voteTask(String taskID, String status) throws Exception
taskID
- status
- Exception
boolean isThresholdReached(String taskID) throws PortalException
taskID
- PortalException
void removeTaskVotes(String taskID) throws Exception
taskID
- Exception
void rollbackTask(String taskID, String auditID) throws Exception
taskID
- auditID
- Exception
ITaskInfo getCurrentTask() throws Exception
Exception
void setDefaultMonitorISConfig() throws Exception
Exception
String getProcessDeployVersion(String processInstanceID) throws Exception
processInstanceID
- Exception
boolean isProcessArchived(String processID) throws Exception
Exception
int searchUserTasksTotalCount(TaskSearchQueryV2 taskQuery, boolean businessData) throws Exception
taskQuery
- specifies the search criteriabusinessData
- indicates whether business data is included in the search or notException
List<ITaskSearchRecord> searchUserTasksPaged(TaskSearchQueryV2 taskQuery, boolean businessData) throws Exception
taskQuery
- specifies the search criteriabusinessData
- indicates whether business data is included in the search or notException
int searchAllTasksTotalCount(TaskSearchQueryV2 taskQuery, boolean businessData) throws Exception
taskQuery
- specifies the search criteriabusinessData
- indicates whether business data is included in the search or notException
List<ITaskSearchRecord> searchAllTasksPaged(TaskSearchQueryV2 taskQuery, boolean businessData) throws Exception
taskQuery
- specifies the search criteriabusinessData
- indicates whether business data is included in the search or notException