Package com.adobe.granite.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 TypeMethodDescriptionReturns the list of possible destinations.getId()Returns a unique ID for the route.getName()Returns the a user friendly name for the route.booleanIndicates if one theRoutesWorkflowTransitions is marked as default.booleanReturns true if the route defines to aWorkflowNodewhich has already been passed.
-
Method Details
-
getId
String getId()Returns a unique ID for the route. This ID must be unique across all routes that are returned from.WorkflowSession.getRoutes(WorkItem, boolean))}- Returns:
- The ID of the route.
-
getName
String getName()Returns the a user friendly name for the route.- Returns:
- The name of the route.
-
hasDefault
boolean hasDefault()Indicates if one theRoutesWorkflowTransitions is marked as default.- Returns:
- True if one
WorkflowTransitionis marked as default, otherwise false.
-
getDestinations
List<WorkflowTransition> getDestinations()Returns the list of possible destinations.- Returns:
- List of
WorkflowTransitions that lead selectableWorkflowNodes.
-
isBackRoute
boolean isBackRoute()Returns true if the route defines to aWorkflowNodewhich has already been passed.- Returns:
trueif it is a "back" route otherwisefalse
-