org.statefulj.framework.core.model

Interface StatefulFSM<T>

Type Parameters:

T - The class of the Stateful Entity

All Known Implementing Classes:

StatefulFSMImpl

public interface StatefulFSM<T>

The StatefulFSM provides the ability to route Events directly to the FSM. This is done by invoking the onEvent method of the associated StatefulFSM class. To obtain a reference to the StatefulFSM, you annotate a reference with the FSM annotation. The StatefulJ Framework will automatically inject the StatefulFSM based off the declared Generic Type. If there is more than one StatefulController that qualifies, then you can provide the bean Id of the specific StatefulController

Author:

Andrew Hall

Method Summary

Modifier and Type	Method and Description
Object	onEvent(String event, Object... parms) Pass an event to the FSM for a non-existent Stateful Entity.
Object	onEvent(T stateful, String event, Object... parms) Pass an event to the FSM for existing Stateful Entity

Method Detail

onEvent

Object onEvent(String event,
               Object... parms)
        throws TooBusyException

Pass an event to the FSM for a non-existent Stateful Entity. The StatefulJ framework will instiate a new Stateful Event by invoking the Factory

Parameters:

event - the Event

parms - Optional parameters passed into the Action method

Returns:

the returned Object from the Action Method

Throws:

TooBusyException - thrown if the FSM cannot process the event

onEvent

Object onEvent(T stateful,
               String event,
               Object... parms)
        throws TooBusyException

Pass an event to the FSM for existing Stateful Entity

Parameters:

stateful - the Stateful Entity

event - the Event

parms - Optional parameters passed into the Action method

Returns:

the returned Object from the Action Method

Throws:

TooBusyException - thrown if the FSM cannot process the event