com.day.cq.workflow.exec

Interface Route

public interface Route

Route represents the possible next destinations which will be selectable after a WorkItem is completed.

Method Summary

Modifier and Type	Method and Description
java.util.List<WorkflowTransition>	getDestinations() Returns the list of possible destinations.
java.lang.String	getId() Returns a unique ID for the route.
java.lang.String	getName() Returns the a user friendly name for the route.
boolean	hasDefault() Indicates if one the Routes WorkflowTransitions is marked as default.
boolean	isBackRoute() Returns true if the route defines to a WorkflowNode which has already been passed.

Method Detail

getId

java.lang.String getId()

Returns a unique ID for the route. This ID must be unique across all routes that are returned from WorkflowSession.getRoutes(WorkItem).

Returns:

The ID of the route.

getName

java.lang.String getName()

Returns the a user friendly name for the route.

Returns:

The name of the route.

hasDefault

boolean hasDefault()

Indicates if one the Routes WorkflowTransitions is marked as default.

Returns:

True if one WorkflowTransition is marked as default, otherwise false.

getDestinations

java.util.List<WorkflowTransition> getDestinations()

Returns the list of possible destinations.

Returns:

List of WorkflowTransitions that lead selectable WorkflowNodes.

isBackRoute

boolean isBackRoute()

Returns true if the route defines to a WorkflowNode which has already been passed.

Returns:

true if it is a "back" route otherwise false