com.caplin.datasource.messaging.record

Interface WrapperMessage

All Superinterfaces:

Message

public interface WrapperMessage
extends Message

Interface for wrapping multiple messages of the same type together into one message.

WrapperMessages are only useful for wrapping RecordType2Message, RecordType3Message and PermissionMessages. WrapperMessages are be published as one merged update by DataSource. A WrapperMessage will ignore any setImage and setNonActive flags from any added messages, instead the setImage and setNoneActive flags must be set on the WrapperMessage itself.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMessage(Message message) Adds a message to the WrapperMessage, the first message defines the message type.
java.util.List<Message>	getMessages() Returns the list of messages in the order they were added.

Methods inherited from interface com.caplin.datasource.messaging.Message

getSubject, isImage, setImage

Method Detail

addMessage

void addMessage(Message message)

Adds a message to the WrapperMessage, the first message defines the message type. If another message of a different type to the first message is added, then a RuntimeException is thrown.

Parameters:

message - the message to add to the wrapper

Throws:

java.lang.RuntimeException - when the message added is a different type to the first one added

getMessages

java.util.List<Message> getMessages()

Returns the list of messages in the order they were added.

Returns:

list of messages