public interface ProcessEngine
Modifier and Type | Method and Description |
---|---|
String |
createProcessInstance(String processDefinitionId)
Creates a process instance according to the referenced process definition, persists it into the database and returns it identifier.
|
String |
createProcessInstance(String processDefinitionId,
ExecutionContext executionContext)
Creates a process instance according to the referenced process definition, persists it into the database and returns it identifier.
|
void |
deleteProcessInstance(String processInstanceId)
Delete a process instance
|
ProcessInstance |
getProcessInstance(String processInstanceId)
Returns the process instance with a given
processInstanceId . |
String |
registerProcessDefinition(InputStream processDefinitionInputStream)
Registers a new process definition given as
InputStream . |
void |
registerProcessDefinition(ProcessDefinition processDefinition)
Registers a new process definition.
|
void |
signal(at.gv.egovernment.moa.id.commons.api.IRequest pendingReq)
Resumes process execution after an asynchronous task has been executed.
|
void |
start(at.gv.egovernment.moa.id.commons.api.IRequest pendingReq)
Starts the process using the given
pendingReq . |
void registerProcessDefinition(ProcessDefinition processDefinition)
processDefinition
- The process definition to be registered.String registerProcessDefinition(InputStream processDefinitionInputStream) throws ProcessDefinitionParserException
InputStream
. Note that existing definitions with the same identifier will be replaced.processDefinitionInputStream
- The input stream to the definition to be registered.ProcessDefinitionParserException
- Thrown in case of an error parsing the process definition.String createProcessInstance(String processDefinitionId, ExecutionContext executionContext) throws ProcessExecutionException
#start(String)
and
#signal(String)
for further information).processDefinitionId
- The identifier of the respective process definition.executionContext
- The execution context (may be null
).null
).ProcessExecutionException
- Thrown in case of error, e.g. when a processDefinitionId
is referenced that does not exist.String createProcessInstance(String processDefinitionId) throws ProcessExecutionException
#start(String)
and
#signal(String)
for further information).processDefinitionId
- The identifier of the respective process definition.null
).ProcessExecutionException
- Thrown in case of error, e.g. when a processDefinitionId
is referenced that does not exist.void deleteProcessInstance(String processInstanceId) throws ProcessExecutionException
processInstanceId
- The identifier of the respective process.ProcessExecutionException
- Thrown in case of error, e.g. when a processInstanceId
is referenced that does not exist.ProcessInstance getProcessInstance(String processInstanceId)
processInstanceId
.processInstanceId
- The process instance id.null
).IllegalArgumentException
- In case the process instance does not/no longer exist.RuntimeException
- In case the process instance could not be retrieved from persistence.void start(at.gv.egovernment.moa.id.commons.api.IRequest pendingReq) throws ProcessExecutionException
pendingReq
.pendingReq
- The protocol request for which a process should be started.ProcessExecutionException
- Thrown in case of error.void signal(at.gv.egovernment.moa.id.commons.api.IRequest pendingReq) throws ProcessExecutionException
pendingReq
- The process instance id.ProcessExecutionException
- Thrown in case of error.Copyright © 2017. All rights reserved.