de.hybris.platform.processengine.definition

Interface ProcessDefinitionFactory

All Known Implementing Classes:

DefaultProcessDefinitionFactory

public interface ProcessDefinitionFactory

Method Summary

Modifier and Type	Method and Description
String	add(File definitionFile) Add file to extract process definition from.
void	add(ProcessDefinition definition) add ProcessDefinition into factory.
String	add(Resource resource) Add resource to extract process definition from.
String	add(String location) Add location (read by ApplicationContext.getResource(String)) to extract process definition from.
String	add(URL definitionURL) Add URL to extract process definition from.
Set<String>	getAllProcessDefinitionsNames() Gets set of all available process definitions names.
ProcessDefinition	getProcessDefinition(ProcessDefinitionId id) gets the ProcessDefinition by id
ProcessDefinition	getProcessDefinition(String processDefinitionName) Deprecated. use getProcessDefinition(ProcessDefinitionId)
boolean	isProcessWaitingOnTask(ProcessDefinitionId id, String action) Return true if in process definition action is wait.
boolean	isProcessWaitingOnTask(String processDefinitionName, String action) Deprecated. use isProcessWaitingOnTask(ProcessDefinitionId, String)
boolean	remove(ProcessDefinitionId id) Remove process definition by id.
boolean	remove(String processName) Deprecated. use remove(ProcessDefinitionId)

Method Detail

getProcessDefinition

ProcessDefinition getProcessDefinition(ProcessDefinitionId id)

gets the ProcessDefinition by id

Parameters:

id - id of process definition.

getProcessDefinition

@Deprecated
ProcessDefinition getProcessDefinition(String processDefinitionName)

Deprecated. use getProcessDefinition(ProcessDefinitionId)

gets the ProcessDefinition by name.

Parameters:

processDefinitionName - name of process definition.

getAllProcessDefinitionsNames

Set<String> getAllProcessDefinitionsNames()

Gets set of all available process definitions names.

add

void add(ProcessDefinition definition)

add ProcessDefinition into factory.

Parameters:

definition - added definition.

add

String add(String location)
    throws IOException

Add location (read by ApplicationContext.getResource(String)) to extract process definition from.

Parameters:

location - added location

Throws:

IOException

add

String add(URL definitionURL)

Add URL to extract process definition from.

Parameters:

definitionURL - added URL

add

String add(File definitionFile)
    throws IOException

Add file to extract process definition from.

Parameters:

definitionFile - added file

Throws:

IOException

add

String add(Resource resource)
    throws IOException

Add resource to extract process definition from.

Parameters:

resource - added resource

Throws:

IOException

remove

boolean remove(ProcessDefinitionId id)

Remove process definition by id.

Parameters:

id - id of process.

remove

@Deprecated
boolean remove(String processName)

Deprecated. use remove(ProcessDefinitionId)

Remove process definition by name.

Parameters:

processName - name of process.

isProcessWaitingOnTask

boolean isProcessWaitingOnTask(ProcessDefinitionId id,
                               String action)

Return true if in process definition action is wait.

Parameters:

id - id of process definition

action - action name from process definition

isProcessWaitingOnTask

@Deprecated
boolean isProcessWaitingOnTask(String processDefinitionName,
                                           String action)

Deprecated. use isProcessWaitingOnTask(ProcessDefinitionId, String)

Return true if in process definition action is wait.

Parameters:

processDefinitionName - name of process definition

action - action name from process definition