AMETAS.event
Class AMETASMessageEvent

java.lang.Object
  extended byAMETAS.event.AMETASEvent
      extended byAMETAS.event.AMETASMessageEvent
All Implemented Interfaces:
java.lang.Cloneable

public class AMETASMessageEvent
extends AMETASEvent
implements java.lang.Cloneable

Benachrichtigung über Ereignisse, die Nachrichten betreffen.


Field Summary
static int ANY_MESSAGE_EVENT
          Diese ID wird nur zur Registrierung benutzt.
static int MESSAGE_RECEIVED_EVENT
          Eine Nachricht ist eingetroffen, die in die Nachrichtenmaske passt, die der PU registriert hat.
static int MESSAGE_REMOVED_EVENT
          Eine Nachricht ist eingetroffen, die in die Nachrichtenmaske passt, die der PU registriert hat.
static int OPT_NO_DELETE
          Option für den Eventtyp MESSAGE_RECEIVED_EVENT.
static int OPT_NOTIFY_ONLY
          Option für den Eventtyp MESSAGE_RECEIVED_EVENT.
 
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
AMETASMessageEvent(int nEventID, short nPriority, AMETASMessage[] ames, AMETASMessageID[] amid)
          Konstruktor für ein Nachrichtenereignis.
 
Method Summary
 java.lang.Object clone()
          Erstellt eine Kopie des Events.
static boolean definesID(int nEventID)
          Gibt an, ob die übergebene Event-ID einen MessageEvent bezeichnet.
 java.lang.String getIDString()
          Liefert den symbolischen Namen der ID dieses Events zurück.
 AMETASMessageID[] getMessageIDs()
          Liefert die Nachrichten-IDs als Feld.
 AMETASMessage[] getMessages()
          Liefert die Nachrichten als Feld.
 java.util.Vector getMessagesAsVector()
          Liefert die Nachrichten zu diesem Ereignis als Vektor.
 void setMessages(AMETASMessage[] ames)
          Setzt die Nachrichten dieses Ereignisses.
 
Methods inherited from class AMETAS.event.AMETASEvent
getID, getPriority
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ANY_MESSAGE_EVENT

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

See Also:
Constant Field Values

MESSAGE_RECEIVED_EVENT

public static final int MESSAGE_RECEIVED_EVENT
Eine Nachricht ist eingetroffen, die in die Nachrichtenmaske passt, die der PU registriert hat.

See Also:
Constant Field Values

MESSAGE_REMOVED_EVENT

public static final int MESSAGE_REMOVED_EVENT
Eine Nachricht ist eingetroffen, die in die Nachrichtenmaske passt, die der PU registriert hat.

See Also:
Constant Field Values

OPT_NOTIFY_ONLY

public static final int OPT_NOTIFY_ONLY
Option für den Eventtyp MESSAGE_RECEIVED_EVENT. Die eingetroffene Nachricht wird nicht mitübergeben. Es findet nur eine Notifizierung statt.

See Also:
Constant Field Values

OPT_NO_DELETE

public static final int OPT_NO_DELETE
Option für den Eventtyp MESSAGE_RECEIVED_EVENT. Die Nachricht wird nicht aus dem PostOffice gelöscht.

See Also:
Constant Field Values
Constructor Detail

AMETASMessageEvent

public AMETASMessageEvent(int nEventID,
                          short nPriority,
                          AMETASMessage[] ames,
                          AMETASMessageID[] amid)
Konstruktor für ein Nachrichtenereignis.

Parameters:
nEventID - Typ des Ereignisses
nPriority - Priorität des Ereignisses
ames - Nachrichten
amid - IDs der Nachrichten.
Method Detail

getMessages

public AMETASMessage[] getMessages()
Liefert die Nachrichten als Feld.

Returns:
Nachrichten.

getMessageIDs

public AMETASMessageID[] getMessageIDs()
Liefert die Nachrichten-IDs als Feld.

Returns:
Nachrichten-IDs.

setMessages

public void setMessages(AMETASMessage[] ames)
Setzt die Nachrichten dieses Ereignisses.

Parameters:
ames - Nachrichten.

getMessagesAsVector

public java.util.Vector getMessagesAsVector()
Liefert die Nachrichten zu diesem Ereignis als Vektor.

Returns:
Vektor der Nachrichten dieses Ereignisses.

definesID

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

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

clone

public java.lang.Object clone()
Erstellt eine Kopie des Events. Diese Kopie wird benötigt, damit bei der Herausgabe desselben Event-Objekts keine Manipulationen an den enthaltenen Nachrichten geschehen kann.

Returns:
Kopie.

getIDString

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

Specified by:
getIDString in class AMETASEvent
Returns:
Stringrepräsentation.