org.ikasan.framework.flow
Interface Flow

All Known Implementing Classes:

VisitingInvokerFlow

public interface Flow

Interface representing a business path for an Event Invocation represents the traversal of that business path. Problems/errors are represented by the invocation method returning a IkasanExceptionAction

Author:

Ikasan Development Team

Method Summary

String	getModuleName() Accessor for moduleName
String	getName() Returns the name of this flow
void	invoke(FlowInvocationContext flowInvocationContext, Event event) Invocation of this method represents the handling of the Event with respect to some business path
void	start() Invoke all start operations for the flow that are required prior to an event invocation.
void	stop() Invoke all stop operations for the flow that are required on shutdown of the invoking client.
void	sync() Temporary public method to support a work-around for ensuring dynamic configured resources are always sync'd with their persisted versions after failure/rollback.

Method Detail

invoke

void invoke(FlowInvocationContext flowInvocationContext,
            Event event)

Invocation of this method represents the handling of the Event with respect to some business path

Parameters:

flowInvocationContext - invocation context

event - The event we're dealing with

getName

String getName()

Returns the name of this flow

Returns:

String name of this flow

getModuleName

String getModuleName()

Accessor for moduleName

Returns:

name of the module this flow exist for

start

void start()

Invoke all start operations for the flow that are required prior to an event invocation. For instance, this could include setting any flow component configurations, or starting any flow managed resources.

stop

void stop()

Invoke all stop operations for the flow that are required on shutdown of the invoking client. For instance, this could include stopping any flow managed resources.

sync

void sync()

Temporary public method to support a work-around for ensuring dynamic configured resources are always sync'd with their persisted versions after failure/rollback.