Caplin.DataSource.Messaging.Container.IContainerOperation Interface Reference

Interface that represents a container operation. More...

Inherited by Caplin.DataSource.Messaging.Container.ContainerAddElementOperation, Caplin.DataSource.Messaging.Container.ContainerInsertElementOperation, Caplin.DataSource.Messaging.Container.ContainerRemoveElementOperation, and Caplin.DataSource.Messaging.Container.ContainerRemoveElementsPrefixOperation.

Public Member Functions
void	UpdateContainer (IContainerModel model)
	Updates the container model with the effects of this operation. More...

Properties
int	ElementPosition [get]
	Gets the position at which to insert the element.. More...
string	ElementSubject [get]
	Gets the subject of the element this operation relates to. More...
ContainerOperationType	Type [get]
	Gets the type of the container operation. More...

Detailed Description

Interface that represents a container operation.

Examples of container operations are: Add an element to the end of the container, insert an element at a given position in the container, remove an element from the container, remove elements from the container that have a subject matching a specified prefix.

You add operations to a container message by calling the appropriate methods of IContainerMessage, such as IContainerMessage.AddElement or IContainerMessage.RemoveElement.

You can obtain the operations defined in a IContainerMessage by calling the IContainerMessage.Operations property.

Member Function Documentation

void Caplin.DataSource.Messaging.Container.IContainerOperation.UpdateContainer

(

IContainerModel

model

)

Updates the container model with the effects of this operation.

Parameters

model

Your implementation of IContainerModel which will be updated with the effects of this operation.

If you have defined a model of the container by implementing IContainerModel, call this method from within your implementation to update the model according to the operation. The method invokes the relevant operation callback method on the IContainerModel implementation.

Property Documentation

int Caplin.DataSource.Messaging.Container.IContainerOperation.ElementPosition

get

Gets the position at which to insert the element..

The position at which to insert the element.

If this is an

INSERT

operation, this method returns the position in the container where the element is to be inserted (the first position is position 0).

If this is an

ADD

,

REMOVE

or

REMOVE WITH PREFIX

operation, the method throws an InvalidOperationException.

string Caplin.DataSource.Messaging.Container.IContainerOperation.ElementSubject

get

Gets the subject of the element this operation relates to.

The subject or prefix of the element that this operation relates to.

If this is an ADD, REMOVE or INSERT operation, the method returns the subject of the element.

If this is a REMOVE_WITH_PREFIX operation, the method returns the prefix that specifies the elements to remove.

ContainerOperationType Caplin.DataSource.Messaging.Container.IContainerOperation.Type

get

Gets the type of the container operation.

The type of the container operation.