Interface DocumentRoutingEngineService
-
- All Known Implementing Classes:
DocumentRoutingEngineServiceImpl
public interface DocumentRoutingEngineService
The DocumentRoutingEngineService is responsible for managing the lifecycle of the DocumentRoute. This is an internal service, you should use method on theDocumentRoutingService
to start a route.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
cancel(DocumentRoute routeInstance, CoreSession session)
Cancels a route using an unrestricted session.void
resume(DocumentRoute routeInstance, String nodeId, String taskId, Map<String,Object> data, String status, CoreSession session)
Resumes a route, optionnally for a given task only.void
start(DocumentRoute routeInstance, Map<String,Serializable> map, CoreSession session)
Starts a route.
-
-
-
Method Detail
-
start
void start(DocumentRoute routeInstance, Map<String,Serializable> map, CoreSession session)
Starts a route.- Parameters:
routeInstance
- the route instancemap
- the values to pass as initial workflow variablessession
- the session- Since:
- 5.6
-
resume
void resume(DocumentRoute routeInstance, String nodeId, String taskId, Map<String,Object> data, String status, CoreSession session)
Resumes a route, optionnally for a given task only.- Parameters:
routeInstance
- the route instancenodeId
- the node id to resume on (optional)taskId
- the task id that resumes (optional)data
- the data coming from UI formstatus
- the name of the button clicked to submit the associated task formsession
- the session- Since:
- 5.6
-
cancel
void cancel(DocumentRoute routeInstance, CoreSession session)
Cancels a route using an unrestricted session. (@since 5.7.2 the event 'workflowCanceled' is notified.)- Parameters:
routeInstance
- the route instancesession
- the session- Since:
- 5.6
-
-