org.ikasan.framework.flow
Interface FlowElement

All Known Implementing Classes:

FlowElementImpl

public interface FlowElement

FlowElement represents a particular unique usage of a FlowComponent within a flow. FlowElements wrap FlowComponents, providing them with a context specific name. They also define any transitions from this point in flow, this is a mapping of the various potential results that a FlowComponent may return to subsequent (downstream) FlowElements

Author:

Ikasan Development Team

Field Summary

static String

DEFAULT_TRANSITION_NAME Name of the default transition for FlowComponents that have a unique result

Method Summary

String	getComponentName() Accessor for the componentName.
String	getDescription() Returns a human readable description of this FlowElement
FlowComponent	getFlowComponent() Accessor for the wrapped FlowComponent
FlowElement	getTransition(String transitionName) Retrieves the subsequent FlowElement (if any) representing the next node in the flow
Map<String,FlowElement>	getTransitions() Retrieves a Map of all this FlowElement's transitions

Field Detail

DEFAULT_TRANSITION_NAME

static final String DEFAULT_TRANSITION_NAME

Name of the default transition for FlowComponents that have a unique result

See Also:

Constant Field Values

Method Detail

getFlowComponent

FlowComponent getFlowComponent()

Accessor for the wrapped FlowComponent

Returns:

FlowComponent

getComponentName

String getComponentName()

Accessor for the componentName. This is the unique identifier for a FlowElement

Returns:

componentName

getTransition

FlowElement getTransition(String transitionName)

Retrieves the subsequent FlowElement (if any) representing the next node in the flow

Parameters:

transitionName - - this value should be a member of the set of possible results returnable from the wrapped flowComponent

Returns:

FlowElement representing the next node in the flow

getTransitions

Map<String,FlowElement> getTransitions()

Retrieves a Map of all this FlowElement's transitions

Returns:

a Map of all this FlowElement's transitions

getDescription

String getDescription()

Returns a human readable description of this FlowElement

Returns:

String description