Interface WorkflowTaskManager
@ProviderType
public interface WorkflowTaskManager
- Author:
- Micha Kiener, Shuyang Zhou, Brian Wing Shun Chan, Marcellus Tavares
-
Method Summary
Modifier and TypeMethodDescriptionassignWorkflowTaskToRole
(long companyId, long userId, long workflowTaskId, long roleId, String comment, Date dueDate, Map<String, Serializable> workflowContext) assignWorkflowTaskToUser
(long companyId, long userId, long workflowTaskId, long assigneeUserId, String comment, Date dueDate, Map<String, Serializable> workflowContext) completeWorkflowTask
(long companyId, long userId, long workflowTaskId, String transitionName, String comment, Map<String, Serializable> workflowContext) default WorkflowTask
completeWorkflowTask
(long companyId, long userId, long workflowTaskId, String transitionName, String comment, Map<String, Serializable> workflowContext, boolean waitForCompletion) fetchWorkflowTask
(long workflowTaskId) getAssignableUsers
(long workflowTaskId) getNextTransitionNames
(long userId, long workflowTaskId) getNotifiableUsers
(long workflowTaskId) getWorkflowTask
(long workflowTaskId) int
getWorkflowTaskCount
(long companyId, Boolean completed) int
getWorkflowTaskCountByRole
(long companyId, long roleId, Boolean completed) int
getWorkflowTaskCountBySubmittingUser
(long companyId, long userId, Boolean completed) int
getWorkflowTaskCountByUser
(long companyId, long userId, Boolean completed) int
getWorkflowTaskCountByUserRoles
(long companyId, long userId, long workflowInstanceId, Boolean completed) int
getWorkflowTaskCountByUserRoles
(long companyId, long userId, Boolean completed) int
getWorkflowTaskCountByWorkflowInstance
(long companyId, Long userId, long workflowInstanceId, Boolean completed) getWorkflowTasks
(long companyId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) getWorkflowTasksByRole
(long companyId, long roleId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) getWorkflowTasksBySubmittingUser
(long companyId, long userId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) getWorkflowTasksByUser
(long companyId, long userId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) getWorkflowTasksByUserRoles
(long companyId, long userId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) getWorkflowTasksByWorkflowInstance
(long companyId, Long userId, long workflowInstanceId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) getWorkflowTaskWorkflowTransitions
(long workflowTaskId) boolean
hasAssignableUsers
(long workflowTaskId) default boolean
isNotifiableUser
(long userId, long workflowTaskId) default List<WorkflowTask>
search
(long companyId, long userId, String assetTitle, String[] taskNames, String[] assetTypes, Long[] assetPrimaryKeys, String assigneeClassName, Long[] assigneeIds, Date dueDateGT, Date dueDateLT, Boolean completed, Boolean searchByUserRoles, Long workflowDefinitionId, Long[] workflowInstanceIds, Boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) default int
searchCount
(long companyId, long userId, String assetTitle, String[] taskNames, String[] assetTypes, Long[] assetPrimaryKeys, String assigneeClassName, Long[] assigneeIds, Date dueDateGT, Date dueDateLT, Boolean completed, Boolean searchByUserRoles, Long workflowDefinitionId, Long[] workflowInstanceIds, Boolean andOperator) default WorkflowModelSearchResult<WorkflowTask>
searchWorkflowTasks
(long companyId, long userId, String assetTitle, String[] taskNames, String[] assetTypes, Long[] assetPrimaryKeys, String assigneeClassName, Long[] assigneeIds, Date dueDateGT, Date dueDateLT, Boolean completed, boolean searchByActivatedWorkflowHandlers, Boolean searchByUserRoles, Long workflowDefinitionId, Long[] workflowInstanceIds, Boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) updateDueDate
(long companyId, long userId, long workflowTaskId, String comment, Date dueDate)
-
Method Details
-
assignWorkflowTaskToRole
WorkflowTask assignWorkflowTaskToRole(long companyId, long userId, long workflowTaskId, long roleId, String comment, Date dueDate, Map<String, Serializable> workflowContext) throws WorkflowException- Throws:
WorkflowException
-
assignWorkflowTaskToUser
WorkflowTask assignWorkflowTaskToUser(long companyId, long userId, long workflowTaskId, long assigneeUserId, String comment, Date dueDate, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
completeWorkflowTask
WorkflowTask completeWorkflowTask(long companyId, long userId, long workflowTaskId, String transitionName, String comment, Map<String, Serializable> workflowContext) throws PortalException- Throws:
PortalException
-
completeWorkflowTask
default WorkflowTask completeWorkflowTask(long companyId, long userId, long workflowTaskId, String transitionName, String comment, Map<String, Serializable> workflowContext, boolean waitForCompletion) throws PortalException- Throws:
PortalException
-
fetchWorkflowTask
- Throws:
WorkflowException
-
getAssignableUsers
- Throws:
WorkflowException
-
getNextTransitionNames
- Throws:
WorkflowException
-
getNotifiableUsers
- Throws:
WorkflowException
-
getWorkflowTask
- Throws:
WorkflowException
-
getWorkflowTaskCount
- Throws:
WorkflowException
-
getWorkflowTaskCountByRole
int getWorkflowTaskCountByRole(long companyId, long roleId, Boolean completed) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTaskCountBySubmittingUser
int getWorkflowTaskCountBySubmittingUser(long companyId, long userId, Boolean completed) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTaskCountByUser
int getWorkflowTaskCountByUser(long companyId, long userId, Boolean completed) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTaskCountByUserRoles
int getWorkflowTaskCountByUserRoles(long companyId, long userId, Boolean completed) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTaskCountByUserRoles
int getWorkflowTaskCountByUserRoles(long companyId, long userId, long workflowInstanceId, Boolean completed) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTaskCountByWorkflowInstance
int getWorkflowTaskCountByWorkflowInstance(long companyId, Long userId, long workflowInstanceId, Boolean completed) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTasks
List<WorkflowTask> getWorkflowTasks(long companyId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTasksByRole
List<WorkflowTask> getWorkflowTasksByRole(long companyId, long roleId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTasksBySubmittingUser
List<WorkflowTask> getWorkflowTasksBySubmittingUser(long companyId, long userId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTasksByUser
List<WorkflowTask> getWorkflowTasksByUser(long companyId, long userId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTasksByUserRoles
List<WorkflowTask> getWorkflowTasksByUserRoles(long companyId, long userId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTasksByWorkflowInstance
List<WorkflowTask> getWorkflowTasksByWorkflowInstance(long companyId, Long userId, long workflowInstanceId, Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
getWorkflowTaskWorkflowTransitions
List<WorkflowTransition> getWorkflowTaskWorkflowTransitions(long workflowTaskId) throws WorkflowException - Throws:
WorkflowException
-
hasAssignableUsers
- Throws:
WorkflowException
-
isNotifiableUser
- Throws:
PortalException
-
search
default List<WorkflowTask> search(long companyId, long userId, String assetTitle, String[] taskNames, String[] assetTypes, Long[] assetPrimaryKeys, String assigneeClassName, Long[] assigneeIds, Date dueDateGT, Date dueDateLT, Boolean completed, Boolean searchByUserRoles, Long workflowDefinitionId, Long[] workflowInstanceIds, Boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
searchCount
default int searchCount(long companyId, long userId, String assetTitle, String[] taskNames, String[] assetTypes, Long[] assetPrimaryKeys, String assigneeClassName, Long[] assigneeIds, Date dueDateGT, Date dueDateLT, Boolean completed, Boolean searchByUserRoles, Long workflowDefinitionId, Long[] workflowInstanceIds, Boolean andOperator) throws WorkflowException - Throws:
WorkflowException
-
searchWorkflowTasks
default WorkflowModelSearchResult<WorkflowTask> searchWorkflowTasks(long companyId, long userId, String assetTitle, String[] taskNames, String[] assetTypes, Long[] assetPrimaryKeys, String assigneeClassName, Long[] assigneeIds, Date dueDateGT, Date dueDateLT, Boolean completed, boolean searchByActivatedWorkflowHandlers, Boolean searchByUserRoles, Long workflowDefinitionId, Long[] workflowInstanceIds, Boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) throws WorkflowException - Throws:
WorkflowException
-
updateDueDate
WorkflowTask updateDueDate(long companyId, long userId, long workflowTaskId, String comment, Date dueDate) throws WorkflowException - Throws:
WorkflowException
-