|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BaseEvent
This interface defines the methods needed to implement a BaseEvent
Field Summary | |
---|---|
static String |
EVENT_ID
|
Method Summary | |
---|---|
void |
addListenerID(String id)
Add a specific listener id this event should be delivered to. |
String |
getEventExtension()
get the event extension |
String |
getEventID()
Get the ID that identifies this event. |
String |
getEventIDWithExtension()
Deprecated. csc010404_1; replaced by getEventURL() |
String |
getEventURL()
Get the URL version of the event. |
List |
getListenerIDs()
Get the list of id's this event is specifically targeted for. |
Map |
getParams()
Get any associated params |
BaseEvent |
getRootEvent()
get the root event source (may be null) |
Object |
getSource()
get the event source (may be null) |
long |
getTimestamp()
Get the timestamp |
boolean |
isHandled()
get the handled status for the event |
void |
reset()
Reset the event to it's default state |
void |
setEventExtension(String iext)
set the event extension |
void |
setHandled(boolean val)
mark the event as handled/unhandled |
void |
setParam(String key,
String val)
Set any associated params |
void |
setParam(String key,
String[] val)
Set any associated params |
void |
setSource(Object isource)
set the source for an event |
void |
touch()
Update the timestamp on the event |
Methods inherited from interface org.barracudamvc.plankton.data.StateMap |
---|
clearState, getState, getStateKeys, getStateStore, putState, removeState |
Field Detail |
---|
static final String EVENT_ID
Method Detail |
---|
void setSource(Object isource)
isource
- the source for this eventObject getSource()
BaseEvent getRootEvent()
void setEventExtension(String iext)
iext
- the target event extensionString getEventExtension()
void setParam(String key, String val)
void setParam(String key, String[] val)
Map getParams()
void setHandled(boolean val)
val
- true if the event is handledboolean isHandled()
void addListenerID(String id)
id
- the Listener ID the event should targetList getListenerIDs()
String getEventID()
String getEventIDWithExtension()
getEventURL()
String getEventURL()
long getTimestamp()
void touch()
void reset()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |