org.finra.herd.service

Interface ActivitiService

All Known Implementing Classes:

ActivitiServiceImpl

public interface ActivitiService

Service interface to Activiti operations. The purpose of this interface is to provide abstraction on top of direct Activiti API (ex. to avoid chaining query builder methods directly in the business logic service layer).

Method Summary

Modifier and Type	Method and Description
void	deleteProcessInstance(String processInstanceId, String deleteReason) Deletes a process instance by the given process instance ID and supplies the given delete reason.
org.activiti.engine.runtime.Execution	getExecutionByProcessInstanceIdAndActivitiId(String processInstanceId, String activitiId) Gets an execution by its process instance ID and activiti ID.
List<org.activiti.engine.history.HistoricActivityInstance>	getHistoricActivityInstancesByProcessInstanceId(String processInstanceId) Gets all historic activity instances by their process instance ID sorted by start time and end time.
org.activiti.engine.history.HistoricProcessInstance	getHistoricProcessInstanceByProcessInstanceId(String processInstanceId) Gets a historic process instance by its process instance ID.
List<org.activiti.engine.history.HistoricProcessInstance>	getHistoricProcessInstancesByStatusAndProcessDefinitionKeys(JobStatusEnum jobStatus, Collection<String> processDefinitionKeys, org.joda.time.DateTime startTime, org.joda.time.DateTime endTime) Gets all historic process instances by their status and process definition keys.
long	getHistoricProcessInstancesCountByStatusAndProcessDefinitionKeys(JobStatusEnum jobStatus, Collection<String> processDefinitionKeys, org.joda.time.DateTime startTime, org.joda.time.DateTime endTime) Gets the count of historic process instances by their status and process definition keys.
String	getJobExceptionStacktrace(String jobId) Gets the stacktrace of a job.
List<org.activiti.engine.runtime.Job>	getJobsWithExceptionByProcessInstanceId(String processInstanceId) Gets all jobs with exceptions by process instance ID.
long	getJobsWithExceptionCountByProcessInstanceId(String processInstanceId) Gets the count of jobs with exceptions by their process instance ID.
org.activiti.engine.repository.ProcessDefinition	getProcessDefinitionById(String processDefinitionId) Gets a process definition by its ID.
List<org.activiti.engine.repository.ProcessDefinition>	getProcessDefinitionsByIds(Set<String> processDefinitionIds) Gets all process definitions by their IDs
org.activiti.engine.runtime.ProcessInstance	getProcessInstanceById(String processInstanceId) Gets a process instance by its ID.
String	getProcessModel(String processDefinitionId) Gets the process model by the given process definition ID.
List<org.activiti.engine.runtime.ProcessInstance>	getSuspendedProcessInstances() Gets a list of all currently suspended process instances.
void	resumeProcessInstance(String processInstanceId) Resumes (activates) the process instance with the given id.
void	signal(String executionId, Map<String,Object> processVariables) Signals an execution at a waiting state to continue with the given variables.
org.activiti.engine.runtime.ProcessInstance	startProcessInstanceByProcessDefinitionId(String processDefinitionId, Map<String,Object> variables) Starts a process instance of a given process definition with the given variables.
void	suspendProcessInstance(String processInstanceId) Suspends the process instance with the given id.

Method Detail

getProcessDefinitionById

org.activiti.engine.repository.ProcessDefinition getProcessDefinitionById(String processDefinitionId)

Gets a process definition by its ID.

Parameters:

processDefinitionId - The process definition ID

Returns:

The process definition

startProcessInstanceByProcessDefinitionId

org.activiti.engine.runtime.ProcessInstance startProcessInstanceByProcessDefinitionId(String processDefinitionId,
                                                                                      Map<String,Object> variables)

Starts a process instance of a given process definition with the given variables.

Parameters:

processDefinitionId - The process definition ID

variables - The variables

Returns:

The process instance

getProcessInstanceById

org.activiti.engine.runtime.ProcessInstance getProcessInstanceById(String processInstanceId)

Gets a process instance by its ID.

Parameters:

processInstanceId - The process instance ID

Returns:

The process instance

getSuspendedProcessInstances

List<org.activiti.engine.runtime.ProcessInstance> getSuspendedProcessInstances()

Gets a list of all currently suspended process instances.

Returns:

the list of currently suspended process instances

getHistoricProcessInstanceByProcessInstanceId

org.activiti.engine.history.HistoricProcessInstance getHistoricProcessInstanceByProcessInstanceId(String processInstanceId)

Gets a historic process instance by its process instance ID.

Parameters:

processInstanceId - The process instance ID

Returns:

The historic process instance

getHistoricActivityInstancesByProcessInstanceId

List<org.activiti.engine.history.HistoricActivityInstance> getHistoricActivityInstancesByProcessInstanceId(String processInstanceId)

Gets all historic activity instances by their process instance ID sorted by start time and end time.

Parameters:

processInstanceId - The process instance ID

Returns:

List of historic activity instances

getJobsWithExceptionByProcessInstanceId

List<org.activiti.engine.runtime.Job> getJobsWithExceptionByProcessInstanceId(String processInstanceId)

Gets all jobs with exceptions by process instance ID.

Parameters:

processInstanceId - The process instance ID

Returns:

List of jobs

getJobExceptionStacktrace

String getJobExceptionStacktrace(String jobId)

Gets the stacktrace of a job.

Parameters:

jobId - The job ID

Returns:

The stacktrace

getProcessDefinitionsByIds

List<org.activiti.engine.repository.ProcessDefinition> getProcessDefinitionsByIds(Set<String> processDefinitionIds)

Gets all process definitions by their IDs

Parameters:

processDefinitionIds - The process definition IDs

Returns:

List of process definitions

getJobsWithExceptionCountByProcessInstanceId

long getJobsWithExceptionCountByProcessInstanceId(String processInstanceId)

Gets the count of jobs with exceptions by their process instance ID.

Parameters:

processInstanceId - The process instance ID

Returns:

The count

getHistoricProcessInstancesByStatusAndProcessDefinitionKeys

List<org.activiti.engine.history.HistoricProcessInstance> getHistoricProcessInstancesByStatusAndProcessDefinitionKeys(JobStatusEnum jobStatus,
                                                                                                                      Collection<String> processDefinitionKeys,
                                                                                                                      org.joda.time.DateTime startTime,
                                                                                                                      org.joda.time.DateTime endTime)

Gets all historic process instances by their status and process definition keys. When job status is RUNNING or SUSPENDED, then all "unfinished" process instances are returned.

Parameters:

jobStatus - The job status. Optional.

processDefinitionKeys - Collection of process definition keys

startTime - an optional job start time

endTime - an optional job end time

Returns:

List of historic process instances

getHistoricProcessInstancesCountByStatusAndProcessDefinitionKeys

long getHistoricProcessInstancesCountByStatusAndProcessDefinitionKeys(JobStatusEnum jobStatus,
                                                                      Collection<String> processDefinitionKeys,
                                                                      org.joda.time.DateTime startTime,
                                                                      org.joda.time.DateTime endTime)

Gets the count of historic process instances by their status and process definition keys. When job status is RUNNING or SUSPENDED, then all "unfinished" process are counted.

Parameters:

jobStatus - The job status. Optional.

processDefinitionKeys - Collection of process definition keys

startTime - an optional job start time

endTime - an optional job end time

Returns:

The count

getExecutionByProcessInstanceIdAndActivitiId

org.activiti.engine.runtime.Execution getExecutionByProcessInstanceIdAndActivitiId(String processInstanceId,
                                                                                   String activitiId)

Gets an execution by its process instance ID and activiti ID.

Parameters:

processInstanceId - The process instance ID

activitiId - The activiti ID

Returns:

The execution

signal

void signal(String executionId,
            Map<String,Object> processVariables)

Signals an execution at a waiting state to continue with the given variables.

Parameters:

executionId - The execution ID

processVariables - The process variables

suspendProcessInstance

void suspendProcessInstance(String processInstanceId)

Suspends the process instance with the given id.

Parameters:

processInstanceId - the process instance id

resumeProcessInstance

void resumeProcessInstance(String processInstanceId)

Resumes (activates) the process instance with the given id.

Parameters:

processInstanceId - the process instance id

getProcessModel

String getProcessModel(String processDefinitionId)

Gets the process model by the given process definition ID.

Parameters:

processDefinitionId - The process definition ID

Returns:

The process model

deleteProcessInstance

void deleteProcessInstance(String processInstanceId,
                           String deleteReason)

Deletes a process instance by the given process instance ID and supplies the given delete reason.

Parameters:

processInstanceId - The process instance ID

deleteReason - The delete reason