com.caplin.motif.fx.trading.orders.submission

Class Order

java.lang.Object

com.caplin.motif.fx.trading.orders.submission.Order

public class Order
extends Object

An object representing one of the legs of a multi-order strategy.

Method Summary

Methods

Modifier and Type	Method and Description
Account	getAccount() Returns the account for this order
ActivationDate	getActivationDate() Returns the activation date of the order
Set<AlertType>	getAlertTypes()
String	getAmount() The amount at which this order which should be executed.
String	getBenchmarkType() Returns the benchmark type of the order.
BuySell	getBuySell() Returns the BuySell direction of this order.
String	getCurrencyPair() Returns the currency pair the amount denominates
String	getDealtCurrency() Returns the currency that the amount denominates.
ExecutionType	getExecutionType() Returns the execution type of the order.
ExpirationDate	getExpirationDate() Returns the expiration date of the order
String	getField(String fieldName) Returns the field value for the specified field.
String	getFillRate() The target rate at which the order should fill.
String	getLegId() The Leg Id as submitted by the client
String	getMargin() The margin or mark-up submitted with this order.
String	getRemarks() The remarks attached to this order
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getLegId

public String getLegId()

The Leg Id as submitted by the client

Returns:

the leg id.

getField

public String getField(String fieldName)

Returns the field value for the specified field. Note that L{d}_ prefix is not required in the specified fieldName parameter.

Parameters:

fieldName - The fieldName without the L{d} prefix.

Returns:

The value of the field.

getExecutionType

public ExecutionType getExecutionType()

Returns the execution type of the order.

Returns:

The execution type.

getAccount

public Account getAccount()

Returns the account for this order

Returns:

The account

getAlertTypes

public Set<AlertType> getAlertTypes()

getActivationDate

public ActivationDate getActivationDate()

Returns the activation date of the order

Returns:

The activation date

getExpirationDate

public ExpirationDate getExpirationDate()

Returns the expiration date of the order

Returns:

The expiration date

getDealtCurrency

public String getDealtCurrency()

Returns the currency that the amount denominates.

Returns:

The dealt currency.

getBuySell

public BuySell getBuySell()

Returns the BuySell direction of this order.

Returns:

The BuySell direction of this order

getBenchmarkType

public String getBenchmarkType()

Returns the benchmark type of the order.

Returns:

The benchmark type of the order if this is a benchmark order, otherwise null.

getAmount

public String getAmount()

The amount at which this order which should be executed.

Returns:

The amount, which may contain decimals. This value is specified in the currency returned by the getDealtCurrency() method.

getCurrencyPair

public String getCurrencyPair()

Returns the currency pair the amount denominates

Returns:

The currency pair

getRemarks

public String getRemarks()

The remarks attached to this order

Returns:

The remarks

getFillRate

public String getFillRate()

The target rate at which the order should fill.

Returns:

The target rate, which may contain decimals, if there is a target rate for the order. If this is a market order, this method returns null.

getMargin

public String getMargin()

The margin or mark-up submitted with this order.

Returns:

A string representing a number or null if the value is unknown

toString

public String toString()

Overrides:

toString in class Object