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

Class DocumentRouteImpl

java.lang.Object

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

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

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

All Implemented Interfaces:

Serializable, DocumentRoute, DocumentRouteElement, DocumentRouteStep, DocumentRouteStepsContainer

Direct Known Subclasses:

GraphRouteImpl

public class DocumentRouteImpl
extends DocumentRouteStepsContainerImpl
implements DocumentRoute

Author:

arussel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.ecm.platform.routing.core.impl.DocumentRouteElementImpl

DocumentRouteElementImpl.GetIsParentRunningUnrestricted, DocumentRouteElementImpl.SetDocumentOnReadOnlyUnrestrictedSessionRunner

Nested classes/interfaces inherited from interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement

DocumentRouteElement.ElementLifeCycleState, DocumentRouteElement.ElementLifeCycleTransistion

Field Summary

Fields inherited from class org.nuxeo.ecm.platform.routing.core.impl.DocumentRouteElementImpl

document, runner

Constructor Summary

Constructors

Constructor and Description
DocumentRouteImpl(DocumentModel doc, ElementRunner runner)

Method Summary

Modifier and Type	Method and Description
boolean	canUndoStep(CoreSession session) If this step can be undone.
protected void	fireWorkflowCompletionEvent(CoreSession session)
String	getInitiator() Get the username of the initiator.
String	getModelId()
String	getModelName()
void	setDone(CoreSession session) set this element as done.

Methods inherited from class org.nuxeo.ecm.platform.routing.core.impl.DocumentRouteStepsContainerImpl

getAttachedDocuments, setAttachedDocuments, validate

Methods inherited from class org.nuxeo.ecm.platform.routing.core.impl.DocumentRouteElementImpl

backToReady, cancel, canDeleteStep, canUpdateStep, canValidateStep, checkLifeCycleState, followTransition, getAttachedDocuments, getDescription, getDocument, getDocumentRoute, getName, getProperty, getTitle, hasPermissionOnDocument, isCanceled, isDone, isDraft, isModifiable, isReady, isRunning, isValidated, resume, run, run, save, setCanceled, setCanDeleteStep, setCanReadStep, setCanUpdateStep, setCanValidateStep, setPermissionOnDocument, setReadOnly, setReady, setRunning, setValidated, undo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.routing.api.DocumentRoute

getAttachedDocuments, setAttachedDocuments

Methods inherited from interface org.nuxeo.ecm.platform.routing.api.DocumentRouteElement

backToReady, cancel, canDeleteStep, canUpdateStep, canValidateStep, followTransition, getAttachedDocuments, getDescription, getDocument, getDocumentRoute, getName, getTitle, isCanceled, isDone, isDraft, isModifiable, isReady, isRunning, isValidated, resume, run, run, save, setCanceled, setCanDeleteStep, setCanReadStep, setCanUpdateStep, setCanValidateStep, setReadOnly, setReady, setRunning, setValidated, validate

Constructor Detail

DocumentRouteImpl

public DocumentRouteImpl(DocumentModel doc,
                         ElementRunner runner)

Method Detail

canUndoStep

public boolean canUndoStep(CoreSession session)

Description copied from interface: DocumentRouteElement

If this step can be undone. Default is to allow undoing only if the parent folder is running.

Specified by:

canUndoStep in interface DocumentRouteElement

Overrides:

canUndoStep in class DocumentRouteElementImpl

fireWorkflowCompletionEvent

protected void fireWorkflowCompletionEvent(CoreSession session)

getInitiator

public String getInitiator()

Description copied from interface: DocumentRoute

Get the username of the initiator.

Specified by:

getInitiator in interface DocumentRoute

getModelId

public String getModelId()

Specified by:

getModelId in interface DocumentRoute

Since:

7.2

getModelName

public String getModelName()

Specified by:

getModelName in interface DocumentRoute

Since:

7.2

setDone

public void setDone(CoreSession session)

Description copied from interface: DocumentRouteElement

set this element as done.

Specified by:

setDone in interface DocumentRouteElement

Overrides:

setDone in class DocumentRouteStepsContainerImpl