AMETAS.event
Class AMETASPlaceEvent

java.lang.Object
  extended byAMETAS.event.AMETASEvent
      extended byAMETAS.event.AMETASPlaceEvent

public class AMETASPlaceEvent
extends AMETASEvent

Benachrichtigung über Ereignisse, die die Stelle betreffen.


Field Summary
static int ANY_PLACE_EVENT
          Diese ID wird nur zur Registrierung benutzt.
protected  int m_nGraceTime
          Wenn dies ein PLACE_SHUTDOWN_EVENT ist, dann gibt dieser Wert die Zeit in Sekunden an, die noch verbleibt, bis die Stelle tatsächlich geschlossen wird.
protected  AMETASPlaceUserID m_puidCause
          Die ID des Verursachers des Fehlers.
protected  java.lang.String m_sError
          Enthält die Spezifikation der Fehlernachricht, die parallel zum Abschicken dieses Events im PostOffice abgelegt wird.
protected  java.lang.String m_sInfoText
          Enthält den Text, der den Fehler erklärt (Klartext).
static int PLACE_ERROR_EVENT
          Auf der Stelle ist ein Fehler passiert.
static int PLACE_SHUTDOWN_EVENT
          Die Stelle wird in Kürze beendet.
static int RELAYED_PLACE_ACTIVE_EVENT
          Ein temporäre Stelle ist (wieder) aktiv.
 
Fields inherited from class AMETAS.event.AMETASEvent
ANY_EVENT, HIGH_PRIORITY, HIGHEST_PRIORITY, LOW_PRIORITY, LOWEST_PRIORITY, m_nEventID, m_nPriority, MESSAGE_EVENT_ID_START, NORMAL_PRIORITY, PLACE_EVENT_ID_START, PU_EVENT_ID_START
 
Constructor Summary
AMETASPlaceEvent(int nEventID, int nGraceTime)
          Wird benutzt, wenn ein PLACE_SHUTDOWN_EVENT erzeugt werden soll.
AMETASPlaceEvent(int nEventID, short nPriotity, AMETASPlaceUserID puid, java.lang.String sError, java.lang.String sInfoText)
          Wird benutzt, wenn ein PLACE_ERROR_EVENT erzeugt werden soll.
AMETASPlaceEvent(int nEventID, java.lang.String sError, java.lang.String sInfo)
          Wird benutzt, wenn ein Event hoher Priorität erzeugt werden soll.
 
Method Summary
static boolean definesID(int nEventID)
          Gibt an, ob die übergebene Event-ID einen PlaceEvent bezeichnet.
 AMETASPlaceUserID getCause()
          Gibt den Urheber des Ereignisses zurück.
 java.lang.String getError()
          Gibt den Fehlercode zurück.
 int getGraceTime()
          Gibt die Gnadenfrist zurück.
 java.lang.String getIDString()
          Liefert den symbolischen Namen der ID dieses Events.
 java.lang.String getInfoText()
          Gibt den Informationstext zurück.
 
Methods inherited from class AMETAS.event.AMETASEvent
getID, getPriority
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ANY_PLACE_EVENT

public static final int ANY_PLACE_EVENT
Diese ID wird nur zur Registrierung benutzt. Sie teilt dem EventManager mit, daß alle Events dieser Klasse übermittelt werden sollen.

See Also:
Constant Field Values

PLACE_ERROR_EVENT

public static final int PLACE_ERROR_EVENT
Auf der Stelle ist ein Fehler passiert. Beispiel: Eine Migration kann nicht ausgeführt werden.

See Also:
Constant Field Values

PLACE_SHUTDOWN_EVENT

public static final int PLACE_SHUTDOWN_EVENT
Die Stelle wird in Kürze beendet. Der PlaceUser bekommt noch die Gelegenheit, aufzuräumen, die Stelle zu verlassen usw.

See Also:
Constant Field Values

RELAYED_PLACE_ACTIVE_EVENT

public static final int RELAYED_PLACE_ACTIVE_EVENT
Ein temporäre Stelle ist (wieder) aktiv. Jene Stelle hat sich gerade an diese Stelle gewandt und bittet um eine Bekanntgabe dieser Tatsache. Der Name der Stelle kann mit der Methode getInfoText() ausgelesen werden.

See Also:
Constant Field Values

m_sError

protected java.lang.String m_sError
Enthält die Spezifikation der Fehlernachricht, die parallel zum Abschicken dieses Events im PostOffice abgelegt wird.

See Also:
AMETASMessage

m_sInfoText

protected java.lang.String m_sInfoText
Enthält den Text, der den Fehler erklärt (Klartext). Diese ist der gleiche Text wie in der Fehlernachricht im PostOffice.


m_puidCause

protected AMETASPlaceUserID m_puidCause
Die ID des Verursachers des Fehlers.


m_nGraceTime

protected int m_nGraceTime
Wenn dies ein PLACE_SHUTDOWN_EVENT ist, dann gibt dieser Wert die Zeit in Sekunden an, die noch verbleibt, bis die Stelle tatsächlich geschlossen wird.

Constructor Detail

AMETASPlaceEvent

public AMETASPlaceEvent(int nEventID,
                        short nPriotity,
                        AMETASPlaceUserID puid,
                        java.lang.String sError,
                        java.lang.String sInfoText)
Wird benutzt, wenn ein PLACE_ERROR_EVENT erzeugt werden soll.

Parameters:
nEventID - Art des Ereignisses
nPriotity - Priorität
puid - Verursacher
sError - Fehler
sInfoText - Detailnachricht

AMETASPlaceEvent

public AMETASPlaceEvent(int nEventID,
                        int nGraceTime)
Wird benutzt, wenn ein PLACE_SHUTDOWN_EVENT erzeugt werden soll.

Parameters:
nEventID - Art des Ereignisses
nGraceTime - Zeit bis zum Ende des Stellenbetriebs

AMETASPlaceEvent

public AMETASPlaceEvent(int nEventID,
                        java.lang.String sError,
                        java.lang.String sInfo)
Wird benutzt, wenn ein Event hoher Priorität erzeugt werden soll. Das ist z.B. RELAYED_PLACE_ACTIVE_EVENT.

Parameters:
nEventID - Event
sError - Entsprechender Bezeichner der Nachricht.
sInfo - Genauere Beschreibung (etwa der Stellenname)
Method Detail

getError

public final java.lang.String getError()
Gibt den Fehlercode zurück.

Returns:
Fehler.

getInfoText

public final java.lang.String getInfoText()
Gibt den Informationstext zurück.

Returns:
Detailnachricht.

getCause

public final AMETASPlaceUserID getCause()
Gibt den Urheber des Ereignisses zurück.

Returns:
ID des Verursachers.

getGraceTime

public final int getGraceTime()
Gibt die Gnadenfrist zurück. Dies ist nur von Relevanz für einen PLACE_SHUTDOWN_EVENT.

Returns:
Zeit in Millisekunden.

definesID

public static boolean definesID(int nEventID)
Gibt an, ob die übergebene Event-ID einen PlaceEvent bezeichnet.

Parameters:
nEventID - ID des Events.
Returns:
true, wenn die ID einen PlaceEvent bezechnet, sonst false.

getIDString

public final java.lang.String getIDString()
Liefert den symbolischen Namen der ID dieses Events.

Specified by:
getIDString in class AMETASEvent
Returns:
Name des Ereignisses.