org.alfresco.dataprep

Class WorkflowService

java.lang.Object

org.alfresco.dataprep.CMISUtil

org.alfresco.dataprep.WorkflowService

@Service
public class WorkflowService
extends CMISUtil

Class to create new workflow processes.

Author:

Bogdan Bocancea

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowService.TaskStatus
static class	WorkflowService.WorkflowType

Nested classes/interfaces inherited from class org.alfresco.dataprep.CMISUtil

CMISUtil.DocumentAspect, CMISUtil.DocumentType, CMISUtil.Priority, CMISUtil.Status

Field Summary

Fields inherited from class org.alfresco.dataprep.CMISUtil

alfrescoHttpClientFactory

Constructor Summary

Constructors

Constructor and Description
WorkflowService()

Method Summary

Modifier and Type	Method and Description
boolean	addItemToTask(String assignedUser, String password, String workflowId, String pathToItem) Add an item to a task by path
boolean	addItemToTask(String assignedUser, String password, String workflowId, String itemSite, String itemName) Add an item to a task from site
boolean	approveSiteMembershipRequest(String assignedUser, String password, String taskId, boolean approve, String comment) Approve or reject a Site Membership Request
boolean	approveTask(String assignedUser, String password, String workflowId, boolean approve, WorkflowService.TaskStatus status, String comment) Approve or reject a task
boolean	cancelWorkflow(String owner, String password, String workflowId) Cancel workflow process
boolean	claimTask(String assignedUser, String password, String workflowId) Claim a task
boolean	deleteWorkflow(String owner, String password, String workflowID) Delete workflow process
String	getTaskId(String assignedUser, String password, String workflowId) Get the task id for the user assigned to the task
String	getWorkflowId(String user, String password, String startedBy) Get the workflow id for the user that started a process
boolean	reassignTask(String assignedUser, String password, String workflowId, String reassignTo) Reassign a task to another user
boolean	releaseToPool(String assignedUser, String password, String workflowId) Realese a task to pool
String	startGroupReview(String userName, String password, String message, Date dueDate, String assignedGroup, CMISUtil.Priority priority, List<String> pathToDocs, int requiredApprovePercent, boolean sendEmail) Start a Review And Approve (group review) with items added by path
String	startGroupReview(String userName, String password, String message, Date dueDate, String assignedGroup, CMISUtil.Priority priority, String documentsSite, List<String> documents, int requiredApprovePercent, boolean sendEmail) Start a Review And Approve (group review) with items added from a site
String	startMultipleReviewers(String userName, String password, String message, Date dueDate, List<String> reviewers, CMISUtil.Priority priority, List<String> pathsToDocuments, int requiredApprovePercent, boolean sendEmail) Start a Review And Approve (one or more reviewers) with items added by path
String	startMultipleReviewers(String userName, String password, String message, Date dueDate, List<String> reviewers, CMISUtil.Priority priority, String documentsSite, List<String> documents, int requiredApprovePercent, boolean sendEmail) Start a Review And Approve (one or more reviewers) with items added from a site
String	startNewTask(String userName, String password, String message, Date dueDate, String assignee, CMISUtil.Priority priority, List<String> pathsToItems, boolean sendEmail) Start a new task with items added by path
String	startNewTask(String userName, String password, String message, Date dueDate, String assignee, CMISUtil.Priority priority, String documentsSite, List<String> documents, boolean sendEmail) Start a new task with items added from a site
String	startPooledReview(String userName, String password, String message, Date dueDate, String assignedGroup, CMISUtil.Priority priority, List<String> pathToDocs, boolean sendEmail) Start a Review And Approve (pooled review) with items added by path
String	startPooledReview(String userName, String password, String message, Date dueDate, String assignedGroup, CMISUtil.Priority priority, String documentsSite, List<String> documents, boolean sendEmail) Start a Review And Approve (pooled review) with items added from a site
String	startSingleReview(String userName, String password, String message, Date dueDate, String assignee, CMISUtil.Priority priority, List<String> pathsToItems, boolean sendEmail) Start a Review And Approve (single reviewer) with items added by path
String	startSingleReview(String userName, String password, String message, Date dueDate, String assignee, CMISUtil.Priority priority, String documentsSite, List<String> documents, boolean sendEmail) Start a Review And Approve (single reviewer) with items added from a site
boolean	taskDone(String assignedUser, String password, String workflowId, WorkflowService.TaskStatus status, String comment) Complete a task
boolean	updateTaskStatus(String assignedUser, String password, String workflowId, WorkflowService.TaskStatus status) Update the status of a task

Methods inherited from class org.alfresco.dataprep.CMISUtil

addAspect, addAspect, addProperties, addProperties, addPropertiesByPath, attachDocuments, closeStreams, getCategoryNodeRef, getCmisObject, getCmisObject, getCmisObject, getCMISSession, getDocumentObject, getDocumentObject, getDocumentObject, getFolderObject, getFolderObject, getFolderObject, getNodeRef, getNodeRef, getNodeRefByPath, getNodeRefByPath, getProperties, getProperties, getProperties, getProperties, getPropertyValue, getUserNodeRef, getValues, waitInSeconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkflowService

public WorkflowService()

Method Detail

startNewTask

public String startNewTask(String userName,
                           String password,
                           String message,
                           Date dueDate,
                           String assignee,
                           CMISUtil.Priority priority,
                           String documentsSite,
                           List<String> documents,
                           boolean sendEmail)

Start a new task with items added from a site

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignee - String assignee

priority - Priority

documentsSite - String site containing the items

documents - List documents to add to the task

sendEmail - boolean send email

Returns:

String workflow id

startNewTask

public String startNewTask(String userName,
                           String password,
                           String message,
                           Date dueDate,
                           String assignee,
                           CMISUtil.Priority priority,
                           List<String> pathsToItems,
                           boolean sendEmail)

Start a new task with items added by path

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignee - String assignee

priority - Priority

pathsToItems - List path to items (e.g. Sites/siteId/documentLibrary/doc.txt)

sendEmail - boolean send email

Returns:

String workflow id

startGroupReview

public String startGroupReview(String userName,
                               String password,
                               String message,
                               Date dueDate,
                               String assignedGroup,
                               CMISUtil.Priority priority,
                               String documentsSite,
                               List<String> documents,
                               int requiredApprovePercent,
                               boolean sendEmail)

Start a Review And Approve (group review) with items added from a site

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignedGroup - String assignee group

priority - Priority

documentsSite - String site containing the items

documents - List documents to add to the task

requiredApprovePercent - int required percent

sendEmail - boolean send email

Returns:

String workflow id

startGroupReview

public String startGroupReview(String userName,
                               String password,
                               String message,
                               Date dueDate,
                               String assignedGroup,
                               CMISUtil.Priority priority,
                               List<String> pathToDocs,
                               int requiredApprovePercent,
                               boolean sendEmail)

Start a Review And Approve (group review) with items added by path

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignedGroup - String assignee group

priority - Priority

pathToDocs - List path to items (e.g. Sites/siteId/documentLibrary/doc.txt)

requiredApprovePercent - int required percent

sendEmail - boolean send email

Returns:

String workflow id

startMultipleReviewers

public String startMultipleReviewers(String userName,
                                     String password,
                                     String message,
                                     Date dueDate,
                                     List<String> reviewers,
                                     CMISUtil.Priority priority,
                                     String documentsSite,
                                     List<String> documents,
                                     int requiredApprovePercent,
                                     boolean sendEmail)

Start a Review And Approve (one or more reviewers) with items added from a site

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

reviewers - List list of reviewers

priority - Priority

documentsSite - String site containing the items

documents - List documents to add to the task

requiredApprovePercent - int required percent

sendEmail - boolean send email

Returns:

String workflow id

startMultipleReviewers

public String startMultipleReviewers(String userName,
                                     String password,
                                     String message,
                                     Date dueDate,
                                     List<String> reviewers,
                                     CMISUtil.Priority priority,
                                     List<String> pathsToDocuments,
                                     int requiredApprovePercent,
                                     boolean sendEmail)

Start a Review And Approve (one or more reviewers) with items added by path

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

reviewers - List list of reviewers

priority - Priority

pathsToDocuments - List path to items (e.g. Sites/siteId/documentLibrary/doc.txt)

requiredApprovePercent - int required percent

sendEmail - boolean send email

Returns:

String workflow id

startPooledReview

public String startPooledReview(String userName,
                                String password,
                                String message,
                                Date dueDate,
                                String assignedGroup,
                                CMISUtil.Priority priority,
                                String documentsSite,
                                List<String> documents,
                                boolean sendEmail)

Start a Review And Approve (pooled review) with items added from a site

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignedGroup - String review group

priority - Priority

documentsSite - String site containing the items

documents - List documents to add to the task

sendEmail - boolean send email

Returns:

String workflow id

startPooledReview

public String startPooledReview(String userName,
                                String password,
                                String message,
                                Date dueDate,
                                String assignedGroup,
                                CMISUtil.Priority priority,
                                List<String> pathToDocs,
                                boolean sendEmail)

Start a Review And Approve (pooled review) with items added by path

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignedGroup - String review group

priority - Priority

pathToDocs - List path to items (e.g. Sites/siteId/documentLibrary/doc.txt)

sendEmail - boolean send email

Returns:

String workflow id

startSingleReview

public String startSingleReview(String userName,
                                String password,
                                String message,
                                Date dueDate,
                                String assignee,
                                CMISUtil.Priority priority,
                                String documentsSite,
                                List<String> documents,
                                boolean sendEmail)

Start a Review And Approve (single reviewer) with items added from a site

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignee - String user assigned

priority - Priority

documentsSite - String site containing the items

documents - List documents to add to the task

sendEmail - boolean send email

Returns:

String workflow id

startSingleReview

public String startSingleReview(String userName,
                                String password,
                                String message,
                                Date dueDate,
                                String assignee,
                                CMISUtil.Priority priority,
                                List<String> pathsToItems,
                                boolean sendEmail)

Start a Review And Approve (single reviewer) with items added by path

Parameters:

userName - String user name

password - String password

message - String message

dueDate - Date due date

assignee - String user assigned

priority - Priority

pathsToItems - List path to items (e.g. Sites/siteId/documentLibrary/doc.txt)

sendEmail - boolean send email

Returns:

String workflow id

getTaskId

public String getTaskId(String assignedUser,
                        String password,
                        String workflowId)

Get the task id for the user assigned to the task

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

Returns:

String task id

updateTaskStatus

public boolean updateTaskStatus(String assignedUser,
                                String password,
                                String workflowId,
                                WorkflowService.TaskStatus status)

Update the status of a task

Parameters:

assignedUser - String user assigned to the task

password - String password

workflowId - String workflow Id

status - TaskStatus the status

Returns:

true if 201 code is returned

reassignTask

public boolean reassignTask(String assignedUser,
                            String password,
                            String workflowId,
                            String reassignTo)

Reassign a task to another user

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

reassignTo - String user to reassign task

Returns:

taskDone

public boolean taskDone(String assignedUser,
                        String password,
                        String workflowId,
                        WorkflowService.TaskStatus status,
                        String comment)

Complete a task

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

status - TaskStatus status

comment - String comment

Returns:

true if task is completed

claimTask

public boolean claimTask(String assignedUser,
                         String password,
                         String workflowId)

Claim a task

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

Returns:

true if task is claimed

releaseToPool

public boolean releaseToPool(String assignedUser,
                             String password,
                             String workflowId)

Realese a task to pool

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

Returns:

true if task is released

approveTask

public boolean approveTask(String assignedUser,
                           String password,
                           String workflowId,
                           boolean approve,
                           WorkflowService.TaskStatus status,
                           String comment)

Approve or reject a task

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

approve - boolean approve or reject

status - TaskStatus task status

comment - String comment

Returns:

200 OK if successful

approveSiteMembershipRequest

public boolean approveSiteMembershipRequest(String assignedUser,
                                            String password,
                                            String taskId,
                                            boolean approve,
                                            String comment)

Approve or reject a Site Membership Request

Parameters:

assignedUser - String assigned user

password - String password

taskId - String task id

approve - boolean approve or reject

comment - String comment

Returns:

200 OK if successful

cancelWorkflow

public boolean cancelWorkflow(String owner,
                              String password,
                              String workflowId)

Cancel workflow process

Parameters:

owner - String workflow owner

password - String password

workflowID - String workflowId

Returns:

true if canceled

deleteWorkflow

public boolean deleteWorkflow(String owner,
                              String password,
                              String workflowID)

Delete workflow process

Parameters:

owner - String workflow owner

password - String password

workflowID - String workflowId

Returns:

true if deleted

addItemToTask

public boolean addItemToTask(String assignedUser,
                             String password,
                             String workflowId,
                             String itemSite,
                             String itemName)

Add an item to a task from site

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

itemSite - String site name

itemName - String item

Returns:

true(status 201) if item is added

addItemToTask

public boolean addItemToTask(String assignedUser,
                             String password,
                             String workflowId,
                             String pathToItem)

Add an item to a task by path

Parameters:

assignedUser - String assigned user

password - String password

workflowId - String workflow id

pathToItem - String pathToItem

Returns:

true(status 201) if item is added

getWorkflowId

public String getWorkflowId(String user,
                            String password,
                            String startedBy)

Get the workflow id for the user that started a process

Parameters:

user - String user

password - String password

startedBy - String user that started the process

Returns:

String workflowId