Caplin.DataSource.Messaging.Wrapper.IWrapperMessage Interface Reference

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

Inheritance diagram for Caplin.DataSource.Messaging.Wrapper.IWrapperMessage:

Public Member Functions
void	AddMessage (IMessage 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 an Exception is thrown. More...

Properties
bool	ClearFlag [get, set]
	Gets or sets a boolean value indicating whether this IMessage should be cleared. More...
IList< IMessage >	Messages [get]
	Returns the list of messages in the order they were added. More...
Properties inherited from Caplin.DataSource.Messaging.IMessage
bool	Image [get, set]
	Gets or sets a boolean value indicating whether this IMessage represents an image or an update. More...
string	Subject [get]
	Gets the subject of this message. More...

Detailed Description

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.

Member Function Documentation

void Caplin.DataSource.Messaging.Wrapper.IWrapperMessage.AddMessage

(

IMessage

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 an Exception is thrown.

Parameters

message

The message to add to the wrapper

Exceptions

Exception

When the message added is a different type to the first one added

Property Documentation

bool Caplin.DataSource.Messaging.Wrapper.IWrapperMessage.ClearFlag

getset

Gets or sets a boolean value indicating whether this IMessage should be cleared.

true if this message should clear the object, false if this message should not clear the object.

By default, ClearFlag has a value of false indicating that the IMessage should not be cleared.

IList<IMessage> Caplin.DataSource.Messaging.Wrapper.IWrapperMessage.Messages

get

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

list of messages.