org.barracudamvc.core.event
Interface EventContext

All Superinterfaces:
StateMap
All Known Subinterfaces:
ControlEventContext, ViewEventContext
All Known Implementing Classes:
DefaultEventContext

public interface EventContext
extends StateMap

This interface defines the event context. The context contains information about the event (event, queue, plus request and response info if appropriate). The context also implements StateMap, so you can use it to pass information between event handlers. The scope of the context is only for the duration of an event dispatch cycle (ie. from Http Request to Http Response)


Field Summary
static String BASE_EVENT
           
static String DISPATCH_QUEUE
           
static String VIEW_CAPABILITIES
           
 
Method Summary
 BaseEvent getEvent()
          Get the underlying BaseEvent
 DispatchQueue getQueue()
          Get the underlying DispatchQueue
 ViewCapabilities getViewCapabilities()
          Get the underlying ViewCapabilities
 void persistContext(ClientSideRedirectException re)
          The event context must be able to persist its statemap so that it can reconstruct itself after a ClientSideRedirectException.
 
Methods inherited from interface org.barracudamvc.plankton.data.StateMap
clearState, getState, getStateKeys, getStateStore, putState, removeState
 

Field Detail

BASE_EVENT

public static final String BASE_EVENT

DISPATCH_QUEUE

public static final String DISPATCH_QUEUE

VIEW_CAPABILITIES

public static final String VIEW_CAPABILITIES
Method Detail

getEvent

public BaseEvent getEvent()
Get the underlying BaseEvent

Returns:
the underlying BaseEvent

getQueue

public DispatchQueue getQueue()
Get the underlying DispatchQueue

Returns:
the underlying DispatchQueue

getViewCapabilities

public ViewCapabilities getViewCapabilities()
Get the underlying ViewCapabilities


persistContext

public void persistContext(ClientSideRedirectException re)
The event context must be able to persist its statemap so that it can reconstruct itself after a ClientSideRedirectException. Developers should not normally need to call this method directly.



Copyright © 2004 BarracudaMVC.org All Rights Reserved.