PkgAgentSystem.Messaging
Interface MessageType

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

BroadcastMessage, Message

public interface MessageType

extends Serializable, Cloneable

The common methods for messages, both directed messages and broadcasts. Must be separate, otherwise either Message or BroadcastMessage would have to be subclass of the other, leading to many problems (especially for specialized subtypes, like ebXML messages).

Version:

1.0, 1.7.2000

Author:

Michael Sonntag

See Also:

PkgAgentSystem.Messaging, PkgAgentSystem.Messaging

Method Summary

boolean	fromInitiator() Returns whether this message is from the initiator to the other party/parties or an answer.
AgentIdentity	getAddressee() Returns the identity of the recipient of the message.
long	getConversationTypeID() Returns the ID of the type of conversations handling this message.
long	getDestConversationID() Returns the ID of the conversation at the recipient of the message.
AgentIdentity	getSender() Returns the identity of the sender of the message.
long	getSrcConversationID() Returns the ID of the conversation at the sender of the message.
void	setAddressee(AgentIdentity addressee) Set the addressee of the message.
void	setConversationTypeID(long id) Set the type ID for the conversation.
void	setDestConversationID(long id) Set the ID for the conversation at the destination.
void	setFromInitiator(boolean fromInitiator) Sets whether this message is from the initiator to the other party/parties or an answer.
void	setSender(AgentIdentity sender) Set the sender of the message.
void	setSrcConversationID(long id) Set the ID for the conversation at the sender.

Method Detail

setSrcConversationID

public void setSrcConversationID(long id)

Set the ID for the conversation at the sender. Only allowed if the ID is currently 0.

Parameters:

id - the id of the conversation at the sender (may not be 0)

getSrcConversationID

public long getSrcConversationID()

Returns the ID of the conversation at the sender of the message.

Returns:

conversation ID of the sender

setDestConversationID

public void setDestConversationID(long id)

Set the ID for the conversation at the destination. Only allowed if the ID is currently 0.

Parameters:

id - the id of the conversation at the destination (may not be 0)

getDestConversationID

public long getDestConversationID()

Returns the ID of the conversation at the recipient of the message.

Returns:

conversation ID of the recipient

fromInitiator

public boolean fromInitiator()

Returns whether this message is from the initiator to the other party/parties or an answer.

Returns:

true if the message is from the initiator to the other party/parties

setFromInitiator

public void setFromInitiator(boolean fromInitiator)

Sets whether this message is from the initiator to the other party/parties or an answer.

Parameters:

fromInitiator - Shall be true if the message is from the initiator to the other party/parties, false otherwise

setConversationTypeID

public void setConversationTypeID(long id)

Set the type ID for the conversation. Only allowed if the ID is currently 0.

Parameters:

id - the id of the type of the conversation (may not be 0)

getConversationTypeID

public long getConversationTypeID()

Returns the ID of the type of conversations handling this message.

Returns:

conversation type ID of this message

setSender

public void setSender(AgentIdentity sender)

Set the sender of the message. Only allowed if the sender is currently null.

Parameters:

sender - the sender for the message (may not be null)

getSender

public AgentIdentity getSender()

Returns the identity of the sender of the message.

Returns:

identity of the sender

setAddressee

public void setAddressee(AgentIdentity addressee)

Set the addressee of the message. Only allowed if the addressee is currently null.

Parameters:

sender - the addressee for the message (may not be null)

getAddressee

public AgentIdentity getAddressee()

Returns the identity of the recipient of the message.

Returns:

identity of the recipient