com.caplin.motif.fx.trading.orders.details

Class StrategyBuilder

java.lang.Object

com.caplin.motif.fx.trading.orders.details.StrategyBuilder

public class StrategyBuilder
extends Object

This class provides a builder which is used to construct a strategy which consists or one or more orders and may be populated with fields.

See Also:

OrderBuilder, Order

Constructor Summary

Constructors

Constructor and Description
StrategyBuilder() Creates a new StrategyBuilder.
StrategyBuilder(Strategy previousStrategy) Creates a new StrategyBuilder with previous fieldSets.

Method Summary

Methods

Modifier and Type	Method and Description
OrderBuilder	addOrderBuilder(int legID) Adds an OrderBuilder to this instance of StrategyBuilder with the specified leg ID.
OrderBuilder	addOrderBuilder(int legID, Order previousOrder) Adds an OrderBuilder to this instance of StrategyBuilder with the specified leg ID and previous field set.
Strategy	build() Materialises a Strategy object as configured by the StrategyBuilder.
Strategy	build(boolean isSales) Materialises a Strategy object as configured by the StrategyBuilder, including sales fields if isSales is true.
StrategyFieldSet	getEditableFields() Returns the fields relating to the strategy that can be edited by the user.
StrategyFieldSet	getFixedFields() Returns the fields relating to the strategy that cannot be edited by the user
OrderBuilder	getOrderBuilder(int legID) Gets an OrderBuilder with the specified leg ID.
OrderBuilder	getOrderBuilder(String orderID) Gets an OrderBuilder with the specified order ID.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StrategyBuilder

public StrategyBuilder()

Creates a new StrategyBuilder.

StrategyBuilder

public StrategyBuilder(Strategy previousStrategy)

Creates a new StrategyBuilder with previous fieldSets.

Parameters:

previousStrategy - Previous strategy.

Method Detail

addOrderBuilder

public OrderBuilder addOrderBuilder(int legID,
                           Order previousOrder)

Adds an OrderBuilder to this instance of StrategyBuilder with the specified leg ID and previous field set.

This instance of StrategyBuilderHelper retains a reference to the OrderBuilder so that it can be used to build the corresponding Order when you call build().

Parameters:

legID - The leg ID of the OrderBuilder.

previousOrder - The previous order.

Returns:

The same instance of OrderBuilder, so that this method can be chained.

addOrderBuilder

public OrderBuilder addOrderBuilder(int legID)

Adds an OrderBuilder to this instance of StrategyBuilder with the specified leg ID.

This instance of StrategyBuilderHelper retains a reference to the OrderBuilder so that it can be used to build the corresponding Order when you call build().

Parameters:

legID - The leg ID of the OrderBuilder.

Returns:

The same instance of OrderBuilder, so that this method can be chained.

getOrderBuilder

public OrderBuilder getOrderBuilder(int legID)

Gets an OrderBuilder with the specified leg ID. The OrderBuilder must have been previously registered by calling addOrderBuilder(int) for this method to be able to return it.

Parameters:

legID - The leg ID of the OrderBuilder to retrieve.

Returns:

The OrderBuilder with the provided leg ID, or null if no OrderBuilder can be found.

getOrderBuilder

public OrderBuilder getOrderBuilder(String orderID)

Gets an OrderBuilder with the specified order ID. The OrderBuilder must have been previously registered by calling addOrderBuilder(int) and the order ID must have been set by calling OrderBuilder.setOrderId(String) in order for this method to be able to return it.

Parameters:

orderID - The order ID of the OrderBuilder to retrieve.

Returns:

The OrderBuilder with the provided order ID, or null if no OrderBuilder can be found.

build

public Strategy build()

Materialises a Strategy object as configured by the StrategyBuilder.

Returns:

a new Strategy

See Also:

Strategy

build

public Strategy build(boolean isSales)

Materialises a Strategy object as configured by the StrategyBuilder, including sales fields if isSales is true.

Returns:

a new Strategy

See Also:

Strategy

getFixedFields

public StrategyFieldSet getFixedFields()

Returns the fields relating to the strategy that cannot be edited by the user

Returns:

The fixed fields.

getEditableFields

public StrategyFieldSet getEditableFields()

Returns the fields relating to the strategy that can be edited by the user.

Returns:

The editable fields.

toString

public String toString()

Overrides:

toString in class Object