|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opencms.main.CmsEvent
Event class for OpenCms for system wide events that are thrown by various
operations (e.g. publishing) and can be catched and processed by
classes that implement the I_CmsEventListener
interface.
I_CmsEventListener
Constructor Summary | |
CmsEvent(int type,
java.util.Map data)
Construct a new CmsEvent with the specified parameters. |
Method Summary | |
boolean |
equals(java.lang.Object obj)
|
java.util.Map |
getData()
Provides access to the event data that was passed with this event. |
int |
getType()
Provides access to the event type that was passed with this event. |
java.lang.Integer |
getTypeInteger()
Provides access to the event type as Integer. |
int |
hashCode()
|
java.lang.String |
toString()
Return a String representation of this CmsEvent. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public CmsEvent(int type, java.util.Map data)
The event data Map
provides a facility to
pass objects with the event that contain information about
the event environment. For example, if the event is of type
I_CmsEventListener.EVENT_LOGIN_USER
the Map contains
a single object with the key "data"
and a value
that is the OpenCms user object that represents the user that just logged in.
type
- event typedata
- event dataI_CmsEventListener
Method Detail |
public boolean equals(java.lang.Object obj)
Object.equals(java.lang.Object)
public java.util.Map getData()
public int getType()
Event types of the core OpenCms classes are defined in I_CmsEventListener
.
For your extensions, you should define them in a central class
or interface as public member variables. Make sure the integer values
do not confict with the values from the core classes.
I_CmsEventListener
public java.lang.Integer getTypeInteger()
public int hashCode()
Object.hashCode()
public java.lang.String toString()
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |