org.ikasan.spec.flow

Interface FlowElement<COMPONENT>

public interface FlowElement<COMPONENT>

FlowElement represents a particular unique usage of an operational component within a flow. FlowElements wrap components, 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 component may return to subsequent (downstream) FlowElements

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TRANSITION_NAME Name of the default transition for components that have a unique result

Method Summary

Methods

Modifier and Type	Method and Description
String	getComponentName() Accessor for the componentName.
String	getDescription() Returns a human readable description of this FlowElement
COMPONENT	getFlowComponent() Accessor for the wrapped component.
FlowElementInvoker	getFlowElementInvoker() Getter for the flow element invoker.
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
void	setFlowElementInvoker(FlowElementInvoker<COMPONENT> flowElementInvoker) Setter for the flow element invoker.

Field Detail

DEFAULT_TRANSITION_NAME

static final String DEFAULT_TRANSITION_NAME

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

See Also:

Constant Field Values

Method Detail

getFlowComponent

COMPONENT getFlowComponent()

Accessor for the wrapped component.

Returns:

COMPONENT

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 component

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

getFlowElementInvoker

FlowElementInvoker getFlowElementInvoker()

Getter for the flow element invoker.

Returns:

flowElementInvoker

setFlowElementInvoker

void setFlowElementInvoker(FlowElementInvoker<COMPONENT> flowElementInvoker)

Setter for the flow element invoker.

Parameters:

flowElementInvoker -