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.
Any flags (excluding image and nonactive) on the first message added will be added to the wrapper message.
Modifier and Type | Method and Description |
---|---|
void |
addMessage(Message message)
Adds a message to the WrapperMessage, the first message defines the message type.
|
boolean |
getClearFlag()
Gets a value indicating whether all the Type2/type3 data should be cleared.
|
java.util.List<Message> |
getMessages()
Returns the list of messages in the order they were added.
|
void |
setClearFlag(java.lang.Boolean clearFlag)
Sets a value indicating whether all Type2/type3 data should be cleared.
|
getMessageType, getSubject, isImage, setImage
void addMessage(Message message)
message
- the message to add to the wrapperjava.lang.RuntimeException
- when the message added is a different type to the first one addedjava.util.List<Message> getMessages()
boolean getClearFlag()
True
if all the Type2/type3 data should be cleared; otherwise false
.void setClearFlag(java.lang.Boolean clearFlag)
clearFlag
- True
if all Type2/type3 data should be cleared; otherwise false
.Please send bug reports and comments to Caplin support