com.caplin.motif.fx.ret.orders.details

Interface OrderDetailsGenerator

All Known Implementing Classes:

FxMotifOrderDetailsGenerator

public interface OrderDetailsGenerator

An interface for working with OrderBuilders.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OrderDetailsGenerator.Context

Method Summary

Modifier and Type	Method and Description
void	initialise(OrderDetailsGenerator.Context context) This notifies the OrderDetailsGenerator that it is about to be loaded.
void	populateOrderBuilder(com.caplin.motif.fx.trading.orders.details.OrderBuilder builder, com.caplin.ret.trapi.fx.order.strategy.OrderNode orderNode) Creates a new OrderBuilder and populates it with fields from the given OrderNode.
void	updateOrderBuilderForDeletedOrder(com.caplin.motif.fx.trading.orders.details.OrderBuilder builder, com.caplin.ret.trapi.fx.order.OrderEvent event) Updates an existing OrderBuilder with fields from an OrderEvent.
void	updateOrderBuilderWithHistory(com.caplin.motif.fx.trading.orders.details.OrderBuilder builder, com.caplin.ret.trapi.fx.order.OrderEventHistories orderHistory) Updates an existing OrderBuilder with fields from OrderEventHistories.

Method Detail

initialise

void initialise(OrderDetailsGenerator.Context context)

This notifies the OrderDetailsGenerator that it is about to be loaded. This method will be called by the system once.

You should use this method to perform any initialisation required before the OrderDetailsGenerator is loaded by the system.

populateOrderBuilder

void populateOrderBuilder(com.caplin.motif.fx.trading.orders.details.OrderBuilder builder,
                          com.caplin.ret.trapi.fx.order.strategy.OrderNode orderNode)
                   throws com.caplin.motif.fx.trading.orders.OrderConfigurationException

Creates a new OrderBuilder and populates it with fields from the given OrderNode.

Throws:

com.caplin.motif.fx.trading.orders.OrderConfigurationException

updateOrderBuilderForDeletedOrder

void updateOrderBuilderForDeletedOrder(com.caplin.motif.fx.trading.orders.details.OrderBuilder builder,
                                       com.caplin.ret.trapi.fx.order.OrderEvent event)

Updates an existing OrderBuilder with fields from an OrderEvent.

updateOrderBuilderWithHistory

void updateOrderBuilderWithHistory(com.caplin.motif.fx.trading.orders.details.OrderBuilder builder,
                                   com.caplin.ret.trapi.fx.order.OrderEventHistories orderHistory)

Updates an existing OrderBuilder with fields from OrderEventHistories.