findChildObjects(Long taskId);
AcmTask retrieveTask(Long id);
void createTasks(String taskAssignees, String taskName, String owningGroup, String parentType,
Long parentId) throws AcmCreateObjectFailedException, AcmUserActionFailedException;
byte[] getDiagram(Long id) throws AcmTaskException;
byte[] getDiagram(String processId) throws AcmTaskException;
/**
* Send a signal to an Activiti receive task. Activiti receive tasks cause the business process to halt until
* the receive task is signaled. Receive tasks are used when the business process is waiting for user input, but
* there should not be a user task assigned to anybody.
*
* @param businessProcessId
* processInstanceId of the Activiti business process.
* @param receiveTaskId
* BPMN/XML id of the receive task in the business process BPMN model (NOT the ID of a specific Activiti
* task)
* @throws AcmTaskException
*/
void signalTask(String businessProcessId, String receiveTaskId) throws AcmTaskException;
/**
* Send a message to an Activiti task. Messages are used to alter the normal task flow, for instance when an
* ongoing process should be interrupted and sent back to a specific starting point. In this example, a message
* event could be attached to the current user task, and on receipt of that message, the task would be cancelled
* and the process could resume at some other point (compared to the normal next step if the task would be
* completed normally).
*
* @param taskId
* the ID of a specific Activiti user task
* @param messageName
* the message to be sent.
* @throws AcmTaskException
*/
void messageTask(Long taskId, String messageName) throws AcmTaskException;
/**
* Whether a given process can be initiated. This method is designed for the ArkCase buckslip / routing workflow.
* To be initiatable, the process must be active (not ended or closed), and the current process activity must be
* a receive task with BPMN ID of "rtInitiate".
*
* To initiate such a process, call the signalTask method with "rtInitiate" as the receiveTaskId.
*
* @param businessProcessId
* @return
* @throws AcmTaskException
*/
boolean isInitiatable(String businessProcessId) throws AcmTaskException;
/**
* Whether a given process can be withdrawn. This method is designed for the ArkCase buckslip / routing workflow.
* To be withdrawable, the process must be active (not ended or closed), and the current process activity must be
* a user task.
*
* To withdraw such a process, call the messageTask method with the current user task id as the task
* id,
* and Withdraw Message as the message name.
*
* @param businessProcessId
* @return
* @throws AcmTaskException
*/
boolean isWithdrawable(String businessProcessId) throws AcmTaskException;
/**
* Retrieves the list of future tasks for a business process. Designed for the ArkCase buckslip / routing workflow.
*
* @param businessProcessId
* @return
* @throws AcmTaskException
*/
List getBuckslipFutureTasks(String businessProcessId) throws AcmTaskException;
/**
* Sets the list of future tasks for a business process. Designed for the ArkCase buckslip / routing workflow.
*
* @param businessProcessId
* @param buckslipFutureTasks
* @return
* @throws AcmTaskException
*/
void setBuckslipFutureTasks(String businessProcessId, List buckslipFutureTasks) throws AcmTaskException;
/**
* Retrieves the set of completed tasks for a business process. Designed for the ArkCase buckslip / routing
* workflow.
*
* @param businessProcessId
* @param readFromHistory
* @return
* @throws AcmTaskException
*/
String getBuckslipPastTasks(String businessProcessId, boolean readFromHistory) throws AcmTaskException;
/**
* Retrieves a list of buckslip processes for a given object type and id; any particular object may have zero to
* many active buckslip processes. Use this method if the buckslip process was started on the given object.
*
* @param objectType
* CASE_FILE, COMPLAINT, ...
* @param objectId
* Id of the desired object
*/
List getBuckslipProcessesForObject(String objectType, Long objectId) throws AcmTaskException;
/**
* Retrieves a list of buckslip processes for a given parent object type and id; any particular object may have zero
* to
* many active buckslip processes. Use this method if the buckslip process was started on a child of the given
* object (e.g., on a file within a case).
*
* @param parentObjectType
* CASE_FILE, COMPLAINT, ...
* @param parentObjectId
* Id of the desired object
*/
List getBuckslipProcessesForChildren(String parentObjectType, Long parentObjectId) throws AcmTaskException;
/**
* Retrieves the ID of the completed business process for some Object ex.CASE_FILE
*
* @param objectType
* CASE_FILE, COMPLAINT, ...
* @param objectId
* Id of the desired object
*/
Long getCompletedBuckslipProcessIdForObjectFromSolr(String objectType, Long objectId, Authentication authentication);
/**
* Retrieves the value of process variable of active business process or from the history
*
* @param businessProcessId
* active or non active business process id, ...
* @param processVariableKey
* variable that we want to get
* @param readFromHistory
* does the variable need to be fetched from history if the business process is over
*/
String getBusinessProcessVariable(String businessProcessId, String processVariableKey, boolean readFromHistory) throws AcmTaskException;
/**
* Retrieves the value of process variable of active business process or from the history by object type and
* objectId
*
* @param objectType
* object type for which the business process Id will be fetched
* @param objectId
* object id for which the business process Id will be fetched
* @param processVariableKey
* variable that we want to get
* @param readFromHistory
* does the variable need to be fetched from history if the business process is over
*/
String getBusinessProcessVariableByObjectType(String objectType, Long objectId, String processVariableKey, boolean readFromHistory,
Authentication authentication) throws AcmTaskException;
/**
* Update an existing buckslip process; only the nonConcurEndsApprovals and futureTasks
* properties can be updated. All other changes are ignored.
*
* @param in
* @return The updated process, or null if there is no existing active process with the given process id.
* @throws AcmTaskException
*/
BuckslipProcess updateBuckslipProcess(BuckslipProcess in) throws AcmTaskException;
List startReviewDocumentsWorkflow(AcmTask task, String businessProcessName, Authentication authentication) throws AcmCreateObjectFailedException, AcmUserActionFailedException, LinkAlreadyExistException, AcmObjectNotFoundException;
List startReviewDocumentsWorkflow(AcmTask task, String businessProcessName, Authentication authentication,
List filesToUpload) throws AcmCreateObjectFailedException, AcmUserActionFailedException, LinkAlreadyExistException, AcmObjectNotFoundException;
List startAcmDocumentSingleTaskWorkflow(AcmTask task) throws AcmCreateObjectFailedException, AcmUserActionFailedException, LinkAlreadyExistException, AcmObjectNotFoundException;
void sendAcmDocumentSingleTaskWorkflowMail(Long objectId, String objectType, String approvers);
void createTaskFolderStructureInParentObject(AcmTask task) throws AcmUserActionFailedException, AcmCreateObjectFailedException, AcmObjectNotFoundException, LinkAlreadyExistException;
public void setParticipantsToTaskFolderLink(AcmTask task) throws AcmObjectNotFoundException;
String getTaskFolderNameInParentObject(AcmTask acmTask);
boolean existFilesInTaskAttachFolder(AcmTask acmTask);
}