com.bankframe.fe.statemachine.base.apploaders
Interface IEvent

All Known Subinterfaces:

IEvent

All Known Implementing Classes:

Event, Event, Event, StartupEvent

public interface IEvent

Method Summary

boolean	acceptsSession(IUserSession session) Returns true if the given user session has permission to fire this event.
boolean	allowsResult(IState state) Returns true if the given State is allowed as a result from this Event.
boolean	allowsResult(IStateTransition transition) Returns true if the given state transition is allowed from this event.
IController	getController() Returns the IController implementor which handles this Event.
java.util.Properties	getControllerProperties() Returns the user properties for the state transition.
java.lang.String	getName() Returns the name of this Event.
java.util.Enumeration	getStateTransitions() Returns all allowed state transitions from this event as a java.util.Enumeration.
java.lang.String	getTitle() This method returns a descriptive name for the Event.
IStateTransition	getTransition(java.lang.String name) Returns the state transition with the given name.
IUnitOfWork	getUnitOfWork() Gets the UnitOfWork which contains this event.
java.util.Properties	getUserProperties() Returns the userProperties assiciated with this Event.
boolean	requiresValidation()

Method Detail

allowsResult

public boolean allowsResult(IState state)

Returns true if the given State is allowed as a result from this Event.

Parameters:

state - the state to be tested

Returns:

true if the state is an allowable result from this event.

allowsResult

public boolean allowsResult(IStateTransition transition)

Returns true if the given state transition is allowed from this event.

Returns:

true if the given state transition is allowable from thsi event.

getTitle

public java.lang.String getTitle()

This method returns a descriptive name for the Event. Where appropriate, the return from this method can be used in views in place of the name.

Returns:

the title for this Event.

getName

public java.lang.String getName()

Returns the name of this Event.

Returns:

the name of this Event.

getController

public IController getController()
                          throws ControllerNotFoundException

Returns the IController implementor which handles this Event.

Returns:

IController instance.

Throws:

ControllerNotFoundException

getUnitOfWork

public IUnitOfWork getUnitOfWork()

Gets the UnitOfWork which contains this event.

May be null.

Returns:

the UnitOfWork containing this event, or null.

getStateTransitions

public java.util.Enumeration getStateTransitions()

Returns all allowed state transitions from this event as a java.util.Enumeration.

Returns:

all allowed state transitions from this event.

getTransition

public IStateTransition getTransition(java.lang.String name)

Returns the state transition with the given name.

Returns:

the state transition with the given name.

getUserProperties

public java.util.Properties getUserProperties()

Returns the userProperties assiciated with this Event.

Returns:

userProperties;

acceptsSession

public boolean acceptsSession(IUserSession session)

Returns true if the given user session has permission to fire this event.

Parameters:

session - the user session attempting to access this event.

Returns:

true if this event can accept this user session.

getControllerProperties

public java.util.Properties getControllerProperties()

Returns the user properties for the state transition. May be used to store information about side effects or messages, for instance.

Returns:

userProperties

requiresValidation

public boolean requiresValidation()