|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bankframe.fe.statemachine.base.apploaders.Event com.bankframe.fe.statemachine.ext.apploaders.sax.Event
This class represents an event in the application. The loader will create an instance of this class whenever it finds Event elements in the xml document. It will then add the new event to the State object that owns it.
Constructor Summary | |
Event(org.xml.sax.Attributes atts,
Application application)
This constructor creates a new Event, the Event is initialised with the attribute set given. |
Method Summary | |
boolean |
acceptsSession(IUserSession session)
Returns true if the given user session has permission to fire this event. |
void |
addInputDefinition(IInputDefinition definition)
|
void |
addTransition(StateTransition trans)
|
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. |
IInputRequirements |
getInputRequirements()
|
java.lang.String |
getName()
Returns the name of this Event. |
java.util.Iterator |
getProcesses()
This method returns the processes used by this object. |
java.util.ArrayList |
getProcessNamesList()
Returns the processNamesList. |
ProcessUser |
getProcessUser()
Returns the processUser. |
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()
This method is currently not implemented, returns null. |
java.util.Properties |
getUserProperties()
This method is currently not implemented, returns null. |
void |
initializeProcessUser(java.util.Map processMap)
|
boolean |
isDefaultEvent()
This method returns true if this Event represents a default event. |
boolean |
requiresValidation()
|
void |
setControllerProperties(java.util.Properties newControllerProperties)
|
void |
setProcessNamesList(java.util.ArrayList processNamesList)
Sets the processNamesList. |
void |
setRequiresValidation(boolean newRequiresValidation)
|
Methods inherited from class com.bankframe.fe.statemachine.base.apploaders.Event |
getTitle, getUserProperties |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Event(org.xml.sax.Attributes atts, Application application)
The attribute set should contain the following attributes:
name, the event
controller, the name of the class that handles the even
isDefault should be set to true if this event is a default event,
this attribute is optional.
atts
- org.xml.sax.Attributesapplication
- com.bankframe.fe.sm.saxapploader.Application the application this Event belongs to.Method Detail |
public void addTransition(StateTransition trans)
trans
- public boolean allowsResult(IState state)
IEvent
allowsResult
in interface IEvent
allowsResult
in class Event
state
-
IEvent.allowsResult(IState)
public boolean allowsResult(IStateTransition transition)
IEvent
allowsResult
in interface IEvent
allowsResult
in class Event
transition
-
IEvent.allowsResult(IStateTransition)
public IController getController() throws ControllerNotFoundException
IEvent
getController
in interface IEvent
getController
in class Event
ControllerNotFoundException
exception ControllerNotFoundException
public java.lang.String getName()
IEvent
getName
in interface IEvent
getName
in class Event
IEvent.getName()
public java.util.Enumeration getStateTransitions()
IEvent
getStateTransitions
in interface IEvent
getStateTransitions
in class Event
IEvent.getStateTransitions()
public IStateTransition getTransition(java.lang.String name)
IEvent
getTransition
in interface IEvent
getTransition
in class Event
name
-
IEvent.getTransition(String)
public IUnitOfWork getUnitOfWork()
getUnitOfWork
in interface IEvent
getUnitOfWork
in class Event
public java.util.Properties getUserProperties()
getUserProperties
in interface IEvent
getUserProperties
in class Event
IEvent.getUserProperties()
public java.util.Properties getControllerProperties()
IEvent
getControllerProperties
in interface IEvent
getControllerProperties
in class Event
public void setControllerProperties(java.util.Properties newControllerProperties)
setControllerProperties
in interface IEvent
public boolean isDefaultEvent()
public boolean acceptsSession(IUserSession session)
IEvent
acceptsSession
in interface IEvent
acceptsSession
in class Event
session
- the user session to check
IEvent.acceptsSession(IUserSession)
public java.lang.String getTitle()
IEvent
getTitle
in interface IEvent
getTitle
in class Event
IEvent.getTitle()
public java.util.Iterator getProcesses()
IProcessUser
getProcesses
in interface IProcessUser
IProcessUser.getProcesses()
public IInputRequirements getInputRequirements()
getInputRequirements
in interface IEvent
IEvent.getInputRequirements()
public void addInputDefinition(IInputDefinition definition)
public ProcessUser getProcessUser()
public java.util.ArrayList getProcessNamesList()
public void setProcessNamesList(java.util.ArrayList processNamesList)
processNamesList
- The processNamesList to setpublic void initializeProcessUser(java.util.Map processMap)
public boolean requiresValidation()
requiresValidation
in interface IEvent
public void setRequiresValidation(boolean newRequiresValidation)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |