eaLib API Docs
Last Modified : January 7 2002

mss.ea.al
Interface Message

All Known Implementing Classes:
AbstractMessage

public interface Message

Interface for a message.

Since:
0.2
Version:
$Revision: 1.3 $ $Date: 2001/11/13 10:00:31 $
Author:
Andreas Rummler

Method Summary
 java.util.Collection getCollection()
          Gets the transported collection of objects.
 boolean getDeliverState()
          Flag to indicate, if this message has already passed a message broker.
 long getID()
          Gets the unique identifier of this message.
 java.lang.Object getObject()
          Gets the transported data object.
 java.lang.Object getRecipient()
          Gets the recipient of this message.
 java.lang.Object getSender()
          Gets the sender of this message.
 MessageType getType()
          Gets the type of this message.
 void setDeliverState(boolean state)
          Sets the flag, that this message has passed a message broker.
 boolean transportsCollection()
          Indicates, if this message transports a collection of objects.
 boolean transportsObject()
          Indicates, if this message transports a single object.
 

Method Detail

getID

public long getID()
Gets the unique identifier of this message.
Returns:
unique identifier

getType

public MessageType getType()
Gets the type of this message.
Returns:
type of this message

transportsObject

public boolean transportsObject()
Indicates, if this message transports a single object.
Returns:
true, if this message transports an object

transportsCollection

public boolean transportsCollection()
Indicates, if this message transports a collection of objects.
Returns:
true, if this message transports a collection of objects

getSender

public java.lang.Object getSender()
Gets the sender of this message.
Returns:
sender of this message

getRecipient

public java.lang.Object getRecipient()
Gets the recipient of this message.
Returns:
recipient of this message

getObject

public java.lang.Object getObject()
Gets the transported data object. This method should return null, if no object is transported.
Returns:
transported data object

getCollection

public java.util.Collection getCollection()
Gets the transported collection of objects. This method should return null, if no collection is transported.
Returns:
transported collection of objects

getDeliverState

public boolean getDeliverState()
Flag to indicate, if this message has already passed a message broker. This method could be removed in the future.
Returns:
true if this message passed a broker

setDeliverState

public void setDeliverState(boolean state)
Sets the flag, that this message has passed a message broker. This method could be removed in the future.
Parameters:
state - flag, if this message has passed a message broker

eaLib API Docs
Last Modified : January 7 2002

Copyright © 2000-2001 Technical University of Ilmenau, Department ESS