org.activiti.engine

Interface ProcessEngine

public interface ProcessEngine

Provides access to all the services that expose the BPM and workflow operations.

• RuntimeService: Allows the creation of Deployments and the starting of and searching on ProcessInstances.
• TaskService: Exposes operations to manage human (standalone) Tasks, such as claiming, completing and assigning tasks
• IdentityService: Used for managing Users, Groups and the relations between them<
• ManagementService: Exposes engine admin and maintenance operations
• HistoryService: Service exposing information about ongoing and past process instances.

Typically, there will be only one central ProcessEngine instance needed in a end-user application. Building a ProcessEngine is done through a ProcessEngineConfiguration instance and is a costly operation which should be avoided. For that purpose, it is advised to store it in a static field or JNDI location (or something similar). This is a thread-safe object, so no special precautions need to be taken.

Author:

Tom Baeyens, Joram Barrez

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION the version of the activiti library

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
DynamicBpmnService	getDynamicBpmnService()
org.activiti.form.api.FormService	getFormEngineFormService()
org.activiti.form.api.FormRepositoryService	getFormEngineRepositoryService()
FormService	getFormService()
HistoryService	getHistoryService()
IdentityService	getIdentityService()
ManagementService	getManagementService()
String	getName() The name as specified in 'process-engine-name' in the activiti.cfg.xml configuration file.
ProcessEngineConfiguration	getProcessEngineConfiguration()
RepositoryService	getRepositoryService()
RuntimeService	getRuntimeService()
TaskService	getTaskService()

Field Detail

VERSION

static final String VERSION

the version of the activiti library

See Also:

Constant Field Values

Method Detail

getName

String getName()

The name as specified in 'process-engine-name' in the activiti.cfg.xml configuration file. The default name for a process engine is 'default

close

void close()

getRepositoryService

RepositoryService getRepositoryService()

getRuntimeService

RuntimeService getRuntimeService()

getFormService

FormService getFormService()

getTaskService

TaskService getTaskService()

getHistoryService

HistoryService getHistoryService()

getIdentityService

IdentityService getIdentityService()

getManagementService

ManagementService getManagementService()

getDynamicBpmnService

DynamicBpmnService getDynamicBpmnService()

getProcessEngineConfiguration

ProcessEngineConfiguration getProcessEngineConfiguration()

getFormEngineRepositoryService

org.activiti.form.api.FormRepositoryService getFormEngineRepositoryService()

getFormEngineFormService

org.activiti.form.api.FormService getFormEngineFormService()