com.liferay.portal.kernel.workflow

Interface WorkflowTaskManager

@MessagingProxy(mode=SYNC)
 @ProviderType
public interface WorkflowTaskManager

Author:

Micha Kiener, Shuyang Zhou, Brian Wing Shun Chan, Marcellus Tavares

Method Summary

Modifier and Type	Method and Description
WorkflowTask	assignWorkflowTaskToRole(long companyId, long userId, long workflowTaskId, long roleId, java.lang.String comment, java.util.Date dueDate, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
WorkflowTask	assignWorkflowTaskToUser(long companyId, long userId, long workflowTaskId, long assigneeUserId, java.lang.String comment, java.util.Date dueDate, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
WorkflowTask	completeWorkflowTask(long companyId, long userId, long workflowTaskId, java.lang.String transitionName, java.lang.String comment, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
WorkflowTask	fetchWorkflowTask(long companyId, long workflowTaskId)
java.util.List<java.lang.String>	getNextTransitionNames(long companyId, long userId, long workflowTaskId)
default java.util.List<User>	getPooledActors(long companyId, long workflowTaskId)
long[]	getPooledActorsIds(long companyId, long workflowTaskId) Deprecated. As of Athanasius (7.3.x), replaced by getPooledActors(long, long)
WorkflowTask	getWorkflowTask(long companyId, long workflowTaskId)
int	getWorkflowTaskCount(long companyId, java.lang.Boolean completed)
int	getWorkflowTaskCountByRole(long companyId, long roleId, java.lang.Boolean completed)
int	getWorkflowTaskCountBySubmittingUser(long companyId, long userId, java.lang.Boolean completed)
int	getWorkflowTaskCountByUser(long companyId, long userId, java.lang.Boolean completed)
int	getWorkflowTaskCountByUserRoles(long companyId, long userId, java.lang.Boolean completed)
int	getWorkflowTaskCountByUserRoles(long companyId, long userId, long workflowInstanceId, java.lang.Boolean completed)
int	getWorkflowTaskCountByWorkflowInstance(long companyId, java.lang.Long userId, long workflowInstanceId, java.lang.Boolean completed)
java.util.List<WorkflowTask>	getWorkflowTasks(long companyId, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
java.util.List<WorkflowTask>	getWorkflowTasksByRole(long companyId, long roleId, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
java.util.List<WorkflowTask>	getWorkflowTasksBySubmittingUser(long companyId, long userId, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
java.util.List<WorkflowTask>	getWorkflowTasksByUser(long companyId, long userId, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
java.util.List<WorkflowTask>	getWorkflowTasksByUserRoles(long companyId, long userId, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
java.util.List<WorkflowTask>	getWorkflowTasksByWorkflowInstance(long companyId, java.lang.Long userId, long workflowInstanceId, java.lang.Boolean completed, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
boolean	hasOtherAssignees(long workflowTaskId, long userId)
java.util.List<WorkflowTask>	search(long companyId, long userId, java.lang.String keywords, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)
java.util.List<WorkflowTask>	search(long companyId, long userId, java.lang.String keywords, java.lang.String[] assetTypes, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)
default java.util.List<WorkflowTask>	search(long companyId, long userId, java.lang.String assetTitle, java.lang.String[] taskNames, java.lang.String[] assetTypes, java.lang.Long[] assetPrimaryKeys, java.lang.Long[] assigneeUserIds, java.util.Date dueDateGT, java.util.Date dueDateLT, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, java.lang.Long[] workflowInstanceIds, java.lang.Boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator)
java.util.List<WorkflowTask>	search(long companyId, long userId, java.lang.String taskName, java.lang.String assetType, java.lang.Long[] assetPrimaryKeys, java.util.Date dueDateGT, java.util.Date dueDateLT, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)
default java.util.List<WorkflowTask>	search(long companyId, long userId, java.lang.String assetTitle, java.lang.String taskName, java.lang.String[] assetTypes, java.lang.Long[] assetPrimaryKeys, java.util.Date dueDateGT, java.util.Date dueDateLT, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, java.lang.Boolean andOperator, int start, int end, OrderByComparator<WorkflowTask> orderByComparator) Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)
int	searchCount(long companyId, long userId, java.lang.String keywords, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles) Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)
int	searchCount(long companyId, long userId, java.lang.String keywords, java.lang.String[] assetTypes, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles) Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)
default int	searchCount(long companyId, long userId, java.lang.String assetTitle, java.lang.String[] taskNames, java.lang.String[] assetTypes, java.lang.Long[] assetPrimaryKeys, java.lang.Long[] assigneeUserIds, java.util.Date dueDateGT, java.util.Date dueDateLT, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, java.lang.Long[] workflowInstanceIds, java.lang.Boolean andOperator)
int	searchCount(long companyId, long userId, java.lang.String taskName, java.lang.String assetType, java.lang.Long[] assetPrimaryKeys, java.util.Date dueDateGT, java.util.Date dueDateLT, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, boolean andOperator) Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)
default int	searchCount(long companyId, long userId, java.lang.String assetTitle, java.lang.String taskName, java.lang.String[] assetTypes, java.lang.Long[] assetPrimaryKeys, java.util.Date dueDateGT, java.util.Date dueDateLT, java.lang.Boolean completed, java.lang.Boolean searchByUserRoles, java.lang.Boolean andOperator) Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)
WorkflowTask	updateDueDate(long companyId, long userId, long workflowTaskId, java.lang.String comment, java.util.Date dueDate)

Method Detail

assignWorkflowTaskToRole

WorkflowTask assignWorkflowTaskToRole(long companyId,
                                      long userId,
                                      long workflowTaskId,
                                      long roleId,
                                      java.lang.String comment,
                                      java.util.Date dueDate,
                                      java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                               throws WorkflowException

Throws:

WorkflowException

assignWorkflowTaskToUser

WorkflowTask assignWorkflowTaskToUser(long companyId,
                                      long userId,
                                      long workflowTaskId,
                                      long assigneeUserId,
                                      java.lang.String comment,
                                      java.util.Date dueDate,
                                      java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                               throws WorkflowException

Throws:

WorkflowException

completeWorkflowTask

WorkflowTask completeWorkflowTask(long companyId,
                                  long userId,
                                  long workflowTaskId,
                                  java.lang.String transitionName,
                                  java.lang.String comment,
                                  java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                           throws WorkflowException

Throws:

WorkflowException

fetchWorkflowTask

WorkflowTask fetchWorkflowTask(long companyId,
                               long workflowTaskId)
                        throws WorkflowException

Throws:

WorkflowException

getNextTransitionNames

java.util.List<java.lang.String> getNextTransitionNames(long companyId,
                                                        long userId,
                                                        long workflowTaskId)
                                                 throws WorkflowException

Throws:

WorkflowException

getPooledActors

default java.util.List<User> getPooledActors(long companyId,
                                             long workflowTaskId)
                                      throws WorkflowException

Throws:

WorkflowException

getPooledActorsIds

@Deprecated
long[] getPooledActorsIds(long companyId,
                                      long workflowTaskId)
                               throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by getPooledActors(long, long)

Throws:

WorkflowException

getWorkflowTask

WorkflowTask getWorkflowTask(long companyId,
                             long workflowTaskId)
                      throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCount

int getWorkflowTaskCount(long companyId,
                         java.lang.Boolean completed)
                  throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCountByRole

int getWorkflowTaskCountByRole(long companyId,
                               long roleId,
                               java.lang.Boolean completed)
                        throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCountBySubmittingUser

int getWorkflowTaskCountBySubmittingUser(long companyId,
                                         long userId,
                                         java.lang.Boolean completed)
                                  throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCountByUser

int getWorkflowTaskCountByUser(long companyId,
                               long userId,
                               java.lang.Boolean completed)
                        throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCountByUserRoles

int getWorkflowTaskCountByUserRoles(long companyId,
                                    long userId,
                                    java.lang.Boolean completed)
                             throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCountByUserRoles

int getWorkflowTaskCountByUserRoles(long companyId,
                                    long userId,
                                    long workflowInstanceId,
                                    java.lang.Boolean completed)
                             throws WorkflowException

Throws:

WorkflowException

getWorkflowTaskCountByWorkflowInstance

int getWorkflowTaskCountByWorkflowInstance(long companyId,
                                           java.lang.Long userId,
                                           long workflowInstanceId,
                                           java.lang.Boolean completed)
                                    throws WorkflowException

Throws:

WorkflowException

getWorkflowTasks

java.util.List<WorkflowTask> getWorkflowTasks(long companyId,
                                              java.lang.Boolean completed,
                                              int start,
                                              int end,
                                              OrderByComparator<WorkflowTask> orderByComparator)
                                       throws WorkflowException

Throws:

WorkflowException

getWorkflowTasksByRole

java.util.List<WorkflowTask> getWorkflowTasksByRole(long companyId,
                                                    long roleId,
                                                    java.lang.Boolean completed,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<WorkflowTask> orderByComparator)
                                             throws WorkflowException

Throws:

WorkflowException

getWorkflowTasksBySubmittingUser

java.util.List<WorkflowTask> getWorkflowTasksBySubmittingUser(long companyId,
                                                              long userId,
                                                              java.lang.Boolean completed,
                                                              int start,
                                                              int end,
                                                              OrderByComparator<WorkflowTask> orderByComparator)
                                                       throws WorkflowException

Throws:

WorkflowException

getWorkflowTasksByUser

java.util.List<WorkflowTask> getWorkflowTasksByUser(long companyId,
                                                    long userId,
                                                    java.lang.Boolean completed,
                                                    int start,
                                                    int end,
                                                    OrderByComparator<WorkflowTask> orderByComparator)
                                             throws WorkflowException

Throws:

WorkflowException

getWorkflowTasksByUserRoles

java.util.List<WorkflowTask> getWorkflowTasksByUserRoles(long companyId,
                                                         long userId,
                                                         java.lang.Boolean completed,
                                                         int start,
                                                         int end,
                                                         OrderByComparator<WorkflowTask> orderByComparator)
                                                  throws WorkflowException

Throws:

WorkflowException

getWorkflowTasksByWorkflowInstance

java.util.List<WorkflowTask> getWorkflowTasksByWorkflowInstance(long companyId,
                                                                java.lang.Long userId,
                                                                long workflowInstanceId,
                                                                java.lang.Boolean completed,
                                                                int start,
                                                                int end,
                                                                OrderByComparator<WorkflowTask> orderByComparator)
                                                         throws WorkflowException

Throws:

WorkflowException

hasOtherAssignees

boolean hasOtherAssignees(long workflowTaskId,
                          long userId)
                   throws WorkflowException

Throws:

WorkflowException

search

@Deprecated
java.util.List<WorkflowTask> search(long companyId,
                                                long userId,
                                                java.lang.String keywords,
                                                java.lang.Boolean completed,
                                                java.lang.Boolean searchByUserRoles,
                                                int start,
                                                int end,
                                                OrderByComparator<WorkflowTask> orderByComparator)
                                         throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)

Throws:

WorkflowException

search

@Deprecated
java.util.List<WorkflowTask> search(long companyId,
                                                long userId,
                                                java.lang.String taskName,
                                                java.lang.String assetType,
                                                java.lang.Long[] assetPrimaryKeys,
                                                java.util.Date dueDateGT,
                                                java.util.Date dueDateLT,
                                                java.lang.Boolean completed,
                                                java.lang.Boolean searchByUserRoles,
                                                boolean andOperator,
                                                int start,
                                                int end,
                                                OrderByComparator<WorkflowTask> orderByComparator)
                                         throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)

Throws:

WorkflowException

search

@Deprecated
default java.util.List<WorkflowTask> search(long companyId,
                                                        long userId,
                                                        java.lang.String assetTitle,
                                                        java.lang.String taskName,
                                                        java.lang.String[] assetTypes,
                                                        java.lang.Long[] assetPrimaryKeys,
                                                        java.util.Date dueDateGT,
                                                        java.util.Date dueDateLT,
                                                        java.lang.Boolean completed,
                                                        java.lang.Boolean searchByUserRoles,
                                                        java.lang.Boolean andOperator,
                                                        int start,
                                                        int end,
                                                        OrderByComparator<WorkflowTask> orderByComparator)
                                                 throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)

Throws:

WorkflowException

search

@Deprecated
java.util.List<WorkflowTask> search(long companyId,
                                                long userId,
                                                java.lang.String keywords,
                                                java.lang.String[] assetTypes,
                                                java.lang.Boolean completed,
                                                java.lang.Boolean searchByUserRoles,
                                                int start,
                                                int end,
                                                OrderByComparator<WorkflowTask> orderByComparator)
                                         throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by search(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean, int, int, OrderByComparator)

Throws:

WorkflowException

search

default java.util.List<WorkflowTask> search(long companyId,
                                            long userId,
                                            java.lang.String assetTitle,
                                            java.lang.String[] taskNames,
                                            java.lang.String[] assetTypes,
                                            java.lang.Long[] assetPrimaryKeys,
                                            java.lang.Long[] assigneeUserIds,
                                            java.util.Date dueDateGT,
                                            java.util.Date dueDateLT,
                                            java.lang.Boolean completed,
                                            java.lang.Boolean searchByUserRoles,
                                            java.lang.Long[] workflowInstanceIds,
                                            java.lang.Boolean andOperator,
                                            int start,
                                            int end,
                                            OrderByComparator<WorkflowTask> orderByComparator)
                                     throws WorkflowException

Throws:

WorkflowException

searchCount

@Deprecated
int searchCount(long companyId,
                            long userId,
                            java.lang.String keywords,
                            java.lang.Boolean completed,
                            java.lang.Boolean searchByUserRoles)
                     throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)

Throws:

WorkflowException

searchCount

@Deprecated
int searchCount(long companyId,
                            long userId,
                            java.lang.String taskName,
                            java.lang.String assetType,
                            java.lang.Long[] assetPrimaryKeys,
                            java.util.Date dueDateGT,
                            java.util.Date dueDateLT,
                            java.lang.Boolean completed,
                            java.lang.Boolean searchByUserRoles,
                            boolean andOperator)
                     throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)

Throws:

WorkflowException

searchCount

@Deprecated
default int searchCount(long companyId,
                                    long userId,
                                    java.lang.String assetTitle,
                                    java.lang.String taskName,
                                    java.lang.String[] assetTypes,
                                    java.lang.Long[] assetPrimaryKeys,
                                    java.util.Date dueDateGT,
                                    java.util.Date dueDateLT,
                                    java.lang.Boolean completed,
                                    java.lang.Boolean searchByUserRoles,
                                    java.lang.Boolean andOperator)
                             throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)

Throws:

WorkflowException

searchCount

@Deprecated
int searchCount(long companyId,
                            long userId,
                            java.lang.String keywords,
                            java.lang.String[] assetTypes,
                            java.lang.Boolean completed,
                            java.lang.Boolean searchByUserRoles)
                     throws WorkflowException

Deprecated. As of Athanasius (7.3.x), replaced by searchCount(long, long, String, String[], String[], Long[], Long[], Date, Date, Boolean, Boolean, Long[], Boolean)

Throws:

WorkflowException

searchCount

default int searchCount(long companyId,
                        long userId,
                        java.lang.String assetTitle,
                        java.lang.String[] taskNames,
                        java.lang.String[] assetTypes,
                        java.lang.Long[] assetPrimaryKeys,
                        java.lang.Long[] assigneeUserIds,
                        java.util.Date dueDateGT,
                        java.util.Date dueDateLT,
                        java.lang.Boolean completed,
                        java.lang.Boolean searchByUserRoles,
                        java.lang.Long[] workflowInstanceIds,
                        java.lang.Boolean andOperator)
                 throws WorkflowException

Throws:

WorkflowException

updateDueDate

WorkflowTask updateDueDate(long companyId,
                           long userId,
                           long workflowTaskId,
                           java.lang.String comment,
                           java.util.Date dueDate)
                    throws WorkflowException

Throws:

WorkflowException