Package org.nuxeo.ecm.platform.routing.core.impl

Class DocumentRoutingEngineServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.routing.core.impl.DocumentRoutingEngineServiceImpl

All Implemented Interfaces:

DocumentRoutingEngineService, Adaptable, Component, Extensible, TimestampedService

public class DocumentRoutingEngineServiceImpl
extends DefaultComponent
implements DocumentRoutingEngineService

Field Summary

Fields

Modifier and Type	Field	Description
static String	WORKFLOW_ID_EVENT_PROPERTY_KEY
static String	WORKFLOW_NAME_EVENT_PROPERTY_KEY

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified, name

Constructor Summary

Constructors

Constructor	Description
DocumentRoutingEngineServiceImpl()

Method Summary

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.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, addRuntimeMessage, addRuntimeMessage, deactivate, getAdapter, getDescriptor, getDescriptors, getLastModified, getRegistry, register, registerContribution, registerExtension, setLastModified, setModifiedNow, setName, start, stop, unregister, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.nuxeo.runtime.model.Component

applicationStarted, getApplicationStartedOrder

Field Detail

WORKFLOW_NAME_EVENT_PROPERTY_KEY

public static final String WORKFLOW_NAME_EVENT_PROPERTY_KEY

See Also:

Constant Field Values

WORKFLOW_ID_EVENT_PROPERTY_KEY

public static final String WORKFLOW_ID_EVENT_PROPERTY_KEY

See Also:

Constant Field Values

Constructor Detail

DocumentRoutingEngineServiceImpl

public DocumentRoutingEngineServiceImpl()

Method Detail

start

public void start(DocumentRoute routeInstance,
                  Map<String,Serializable> map,
                  CoreSession session)

Description copied from interface: DocumentRoutingEngineService

Starts a route.

Specified by:

start in interface DocumentRoutingEngineService

Parameters:

routeInstance - the route instance

map - the values to pass as initial workflow variables

session - the session

resume

public void resume(DocumentRoute routeInstance,
                   String nodeId,
                   String taskId,
                   Map<String,Object> data,
                   String status,
                   CoreSession session)

Description copied from interface: DocumentRoutingEngineService

Resumes a route, optionnally for a given task only.

Specified by:

resume in interface DocumentRoutingEngineService

Parameters:

routeInstance - the route instance

nodeId - the node id to resume on (optional)

taskId - the task id that resumes (optional)

data - the data coming from UI form

status - the name of the button clicked to submit the associated task form

session - the session

cancel

public void cancel(DocumentRoute routeInstance,
                   CoreSession session)

Description copied from interface: DocumentRoutingEngineService

Cancels a route using an unrestricted session. (@since 5.7.2 the event 'workflowCanceled' is notified.)

Specified by:

cancel in interface DocumentRoutingEngineService

Parameters:

routeInstance - the route instance

session - the session