org.activiti.engine
Interface RepositoryService

public interface RepositoryService

Service providing access to the repository of process definitions and deployments.

Author:

Tom Baeyens

Method Summary

void	activateProcessDefinitionById(String processDefinitionId) Activates the process definition with the given id.
void	activateProcessDefinitionByKey(String processDefinitionKey) Activates the process definition with the given key (=id in the bpmn20.xml file).
DeploymentBuilder	createDeployment() Starts creating a new deployment
DeploymentQuery	createDeploymentQuery() Query process definitions.
ProcessDefinitionQuery	createProcessDefinitionQuery() Query process definitions.
void	deleteDeployment(String deploymentId) Deletes the given deployment.
void	deleteDeployment(String deploymentId, boolean cascade) Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.
void	deleteDeploymentCascade(String deploymentId) Deprecated. use deleteDeployment(String, boolean). This methods may be deleted from 5.3.
List<String>	getDeploymentResourceNames(String deploymentId) Retrieves a list of deployment resources for the given deployment, ordered alphabetically.
InputStream	getResourceAsStream(String deploymentId, String resourceName) Gives access to a deployment resource through a stream of bytes.
void	suspendProcessDefinitionById(String processDefinitionId) Suspends the process definition with the given id.
void	suspendProcessDefinitionByKey(String processDefinitionKey) Suspends the process definition with the given key (=id in the bpmn20.xml file).

Method Detail

createDeployment

DeploymentBuilder createDeployment()

Starts creating a new deployment

deleteDeployment

void deleteDeployment(String deploymentId)

Deletes the given deployment.

Parameters:

deploymentId - id of the deployment, cannot be null.

deleteDeploymentCascade

void deleteDeploymentCascade(String deploymentId)

Deprecated. use deleteDeployment(String, boolean). This methods may be deleted from 5.3.

Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.

Parameters:

deploymentId - id of the deployment, cannot be null.

deleteDeployment

void deleteDeployment(String deploymentId,
                      boolean cascade)

Deletes the given deployment and cascade deletion to process instances, history process instances and jobs.

Parameters:

deploymentId - id of the deployment, cannot be null.

getDeploymentResourceNames

List<String> getDeploymentResourceNames(String deploymentId)

Retrieves a list of deployment resources for the given deployment, ordered alphabetically.

Parameters:

deploymentId - id of the deployment, cannot be null.

getResourceAsStream

InputStream getResourceAsStream(String deploymentId,
                                String resourceName)

Gives access to a deployment resource through a stream of bytes.

Parameters:

deploymentId - id of the deployment, cannot be null.

resourceName - name of the resource, cannot be null.

Throws:

ActivitiException - when the resource doesn't exist in the given deployment or when no deployment exists for the given deploymentId.

createProcessDefinitionQuery

ProcessDefinitionQuery createProcessDefinitionQuery()

Query process definitions.

createDeploymentQuery

DeploymentQuery createDeploymentQuery()

Query process definitions.

suspendProcessDefinitionById

void suspendProcessDefinitionById(String processDefinitionId)

Suspends the process definition with the given id. If a process definition is in state suspended, activiti will not execute jobs (timers, messages) associated with any process instance of the given definition.

Throws:

ActivitiException - if no such processDefinition can be found or if the process definition is already in state suspended.

suspendProcessDefinitionByKey

void suspendProcessDefinitionByKey(String processDefinitionKey)

Suspends the process definition with the given key (=id in the bpmn20.xml file). If a process definition is in state suspended, activiti will not execute jobs (timers, messages) associated with any process instance of the given definition.

Throws:

ActivitiException - if no such processDefinition can be found or if the process definition is already in state suspended.

activateProcessDefinitionById

void activateProcessDefinitionById(String processDefinitionId)

Activates the process definition with the given id.

Throws:

ActivitiException - if no such processDefinition can be found or if the process definition is already in state active.

activateProcessDefinitionByKey

void activateProcessDefinitionByKey(String processDefinitionKey)

Activates the process definition with the given key (=id in the bpmn20.xml file).

Throws:

ActivitiException - if no such processDefinition can be found or if the process definition is already in state active.