com.bankframe.fe.statemachine.ext.connectors.swing
Class StateMachineEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--java.awt.AWTEvent
              |
              +--com.bankframe.fe.statemachine.ext.connectors.swing.StateMachineEvent
All Implemented Interfaces:
IRequest, IRequest, java.io.Serializable

public class StateMachineEvent
extends java.awt.AWTEvent
implements IRequest

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.awt.AWTEvent
ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK
 
Constructor Summary
StateMachineEvent(java.lang.Object target, java.lang.String eventName)
          Creates new Request.
 
Method Summary
 void addParameter(java.lang.String name, java.lang.String value)
          Adds a parameter to this Event.
 java.lang.String getApplicationName()
          Returns the name of the application that should handle this request.
 java.lang.Object getAttribute(java.lang.String name)
           
 java.util.Enumeration getAttributeNames()
           
 java.lang.String getEventName()
          Returns the name of the event which needs to be handled for this request.
 java.lang.String getParameter(java.lang.String name)
           
 java.util.Enumeration getParameterNames()
          Returns the names of the parameters contained in this request.
 java.lang.String[] getParameterValues(java.lang.String parameterName)
          Returns the values for the parameter of the given name.
 java.lang.String getSessionId()
          Returns the id of the UserSession for this request.
 java.lang.String getStateId()
          Returns the id of the state from which this request comes.
 void setApplicationName(java.lang.String applicationName)
          Sets the current Application name.
 void setAttribute(java.lang.String name, java.lang.Object value)
           
 void setSessionId(java.lang.String sessionId)
          Sets the ID of the current UserSession.
 void setStateId(java.lang.String stateId)
          Sets the ID of the current State.
 
Methods inherited from class java.awt.AWTEvent
getID, paramString, setSource, toString
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StateMachineEvent

public StateMachineEvent(java.lang.Object target,
                         java.lang.String eventName)
Creates new Request.

Parameters:
target - The target Component.
eventName - The statemachine event name.
Method Detail

getApplicationName

public java.lang.String getApplicationName()
Returns the name of the application that should handle this request.

If this returns null the statemachine will use the default application returned by the ApplicationManager.

Specified by:
getApplicationName in interface IRequest
Returns:
the name of the application that should handle this request.

getStateId

public java.lang.String getStateId()
Returns the id of the state from which this request comes.

If this returns null the statemachine will use the root state for the current application.

Specified by:
getStateId in interface IRequest
Returns:
the ID of the state from which this request comes.

getParameterNames

public java.util.Enumeration getParameterNames()
Returns the names of the parameters contained in this request.

Specified by:
getParameterNames in interface IRequest
Returns:
the names of the parameters contained in this request.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String parameterName)
Returns the values for the parameter of the given name.

Specified by:
getParameterValues in interface IRequest
Parameters:
parameterName - the name of the parameter values to return.
Returns:
the values for the parameter of the given name.

getEventName

public java.lang.String getEventName()
Returns the name of the event which needs to be handled for this request.

This should not return null. If no event name is applicable it can return an empty string.

Specified by:
getEventName in interface IRequest
Returns:
the name of the event for this request.

getSessionId

public java.lang.String getSessionId()
Returns the id of the UserSession for this request.

If this returns null the statemachine will create a new default session.

Specified by:
getSessionId in interface IRequest
Returns:
the ID of the IUserSession associated with this request.

setApplicationName

public void setApplicationName(java.lang.String applicationName)
Sets the current Application name.

Parameters:
applicationName - The current application name.

setSessionId

public void setSessionId(java.lang.String sessionId)
Sets the ID of the current UserSession.

Parameters:
sessionId - The ID of the current UserSession.

setStateId

public void setStateId(java.lang.String stateId)
Sets the ID of the current State.

Parameters:
stateId - The ID of the current State.

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)
Adds a parameter to this Event. This method can be called many times to add many values for a parameter.

Parameters:
name - The name of the parameter.
value - The valus of the parameter.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Specified by:
getAttribute in interface IRequest
See Also:
IRequest.getAttribute(String)

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
Specified by:
setAttribute in interface IRequest
See Also:
IRequest.setAttribute(String, Object)

getParameter

public java.lang.String getParameter(java.lang.String name)
Specified by:
getParameter in interface IRequest
See Also:
IRequest.getParameter(String)

getAttributeNames

public java.util.Enumeration getAttributeNames()
Specified by:
getAttributeNames in interface IRequest
See Also:
IRequest.getAttributeNames()


Copyright © 2005 Siebel Systems, Inc. All rights reserved.