com.sas.edir
Class EventQueueMessage

java.lang.Object
  |
  +--com.sas.edir.EventQueueMessage

All Implemented Interfaces:

java.io.Serializable

public class EventQueueMessage

extends java.lang.Object

implements java.io.Serializable

This class encapsulates all the data to represent a message on the event queue. There's the message itself, some other objec to provide context for this message, a key used to filter the message on a get or peek, an application string, and a time stamp.

Version:

1.0

Author:

SAS

See Also:

Serialized Form

Constructor Summary

EventQueueMessage(java.lang.String message, java.lang.Object extraData, EventQueueKey key, java.lang.String application)
construct an EventQueueMessage

Method Summary

java.lang.String	getApplication() Get the application string.
java.lang.Object	getExtraData() Get the extra data object
EventQueueKey	getKey() Get the key object
java.lang.String	getMessage() Return the message text.
void	setApplication(java.lang.String application) Set the application string.
void	setExtraData(java.lang.Object extraData) Set the extra data object
void	setkey(EventQueueKey key) Set the key object
void	setMessage(java.lang.String message) Set the message text.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventQueueMessage

public EventQueueMessage(java.lang.String message,
                         java.lang.Object extraData,
                         EventQueueKey key,
                         java.lang.String application)

construct an EventQueueMessage

Parameters:

message - The text of the event message

extraData - An object which provides context for the message

key - Filter data used for getting the right message(s).

application - The application this message is meant for.

Method Detail

getMessage

public java.lang.String getMessage()

Return the message text.

Returns:

the message text.

setMessage

public void setMessage(java.lang.String message)

Set the message text.

Parameters:

message - The new message text.

getExtraData

public java.lang.Object getExtraData()

Get the extra data object

Returns:

The data object

setExtraData

public void setExtraData(java.lang.Object extraData)

Set the extra data object

Parameters:

extraData - An object providing context to this message

getKey

public EventQueueKey getKey()

Get the key object

Returns:

The message key.

setkey

public void setkey(EventQueueKey key)

Set the key object

Parameters:

key - The new Key for this message

getApplication

public java.lang.String getApplication()

Get the application string.

Returns:

The application this message is intended for.

setApplication

public void setApplication(java.lang.String application)

Set the application string.

Parameters:

The - application this message is intended for.