ides.api.model.supeventset
Class SupEventSetMessage

java.lang.Object
  ides.api.model.supeventset.SupEventSetMessage

public class SupEventSetMessage
extends java.lang.Object

A message sent to subscribers listening to a SupervisoryEventSet.

Author:

Valerie Sugarman

Field Summary

static int	ADD The supervisory event was added
static int	MODIFY The supervisory event was modified
static int	REMOVE The supervisory event was removed

Constructor Summary

SupEventSetMessage(int eventType, long supEventId, SupervisoryEventSet source)
Creates a SupervisoryEventSet message to be passed on to any SupervisoryEventSet subscribers.

SupEventSetMessage(int eventType, long supEventId, SupervisoryEventSet source, java.lang.String messageText)
Creates a SupervisoryEventSet message to be passed on to any SupervisoryEventSet subscribers.

Method Summary

long	getEventId() Retrieve the ID of the SupervisoryEvent in the message.
int	getEventType() Retrieve the type of change (addition, removal or modification).
java.lang.String	getMessage() Retrieve the description of the message.
SupervisoryEventSet	getSource() Retrieve the source of the message.

Methods inherited from class java.lang.Object

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

Field Detail

ADD

public static final int ADD

The supervisory event was added

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

The supervisory event was removed

See Also:

Constant Field Values

MODIFY

public static final int MODIFY

The supervisory event was modified

See Also:

Constant Field Values

Constructor Detail

SupEventSetMessage

public SupEventSetMessage(int eventType,
                          long supEventId,
                          SupervisoryEventSet source,
                          java.lang.String messageText)

Creates a SupervisoryEventSet message to be passed on to any SupervisoryEventSet subscribers.

Parameters:

eventType - the type of change (add, remove, modify).

supEventId - the id of the SupervisoryEvent in the event set.

source - the SupervisoryEventSet where the message originates.

messageText - a descriptions of the message.

SupEventSetMessage

public SupEventSetMessage(int eventType,
                          long supEventId,
                          SupervisoryEventSet source)

Creates a SupervisoryEventSet message to be passed on to any SupervisoryEventSet subscribers.

Parameters:

eventType - the type of change (add, remove, modify).

supEventId - the id of the Supervisory Event in the event set.

source - the SupervisoryEventSet where the message originates.

Method Detail

getSource

public SupervisoryEventSet getSource()

Retrieve the source of the message.

Returns:

the source of the message

getEventType

public int getEventType()

Retrieve the type of change (addition, removal or modification).

Returns:

the type of change (addition, removal or modification)

getMessage

public java.lang.String getMessage()

Retrieve the description of the message.

Returns:

the description of the message

getEventId

public long getEventId()

Retrieve the ID of the SupervisoryEvent in the message.

Returns:

the ID of the SupervisoryEvent in the message