Caplin Systems - Order (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.trading.orders.details.Order

```
public class Order
extends Object
```
This class represents an Order. Instances of this class should be created by calling StrategyBuilder.addOrderBuilder(int) rather than instantiated directly.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Account`	`getAccount()`
`ActivationDate`	`getActivationDate()`
`Set<AlertType>`	`getAlertTypes()`
`String`	`getAmount()`
`String`	`getBenchmarkType()`
`BuySell`	`getBuySell()`
`String`	`getCurrencyPair()`
`String`	`getDealtCurrency()`
`Set<String>`	`getEditableFields()`
`ExecutionType`	`getExecutionType()`
`ExpirationDate`	`getExpirationDate()`
`String`	`getField(String fieldName)` Gets the leg field for the name of the field eg.
`Map<String,String>`	`getFields()` Returns the fields related to this order.
`String`	`getFillRate()`
`int`	`getLegId()` Returns the order's leg id
`String`	`getMemo()`
`String`	`getOrderId()` Returns the order's id
`Order`	`getPreviousOrder()`
`String`	`getRemarks()`
`boolean`	`hasAccountChanged()`
`boolean`	`hasActivationDateChanged()`
`boolean`	`hasAlertTypesChanged()`
`boolean`	`hasAmountChanged()`
`boolean`	`hasBenchmarkTypeChanged()`
`boolean`	`hasBuySellChanged()`
`boolean`	`hasCurrencyPairChanged()`
`boolean`	`hasDealtCurrencyChanged()`
`boolean`	`hasExecutionTypeChanged()`
`boolean`	`hasExpirationDateChanged()`
`boolean`	`hasFieldChanged(String fieldName)`
`boolean`	`hasFillRateChanged()`
`int`	`hashCode()`
`boolean`	`hasMemoChanged()`
`boolean`	`hasOrderChanged()`
`boolean`	`hasOrderEditableFieldsChanged()`
`boolean`	`hasRemarksChanged()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getLegId
```
public int getLegId()
```
Returns the order's leg id

Returns:

the order's leg id

getOrderId
```
public String getOrderId()
```
Returns the order's id

Returns:

the order's id

getFields
```
public Map<String,String> getFields()
```
Returns the fields related to this order.

Returns:

the fields related to this order.

getEditableFields

public Set<String> getEditableFields()

getField
```
public String getField(String fieldName)
```
Gets the leg field for the name of the field eg. fieldName Account will return the field L1_Account if this order is the first leg of the strategy.

Parameters:

fieldName - the name of the field without the leg prefix

Returns:

the value of the field

getAlertTypes
```
public Set<AlertType> getAlertTypes()
```

hasAlertTypesChanged
```
public boolean hasAlertTypesChanged()
```

getAmount
```
public String getAmount()
```

hasAmountChanged
```
public boolean hasAmountChanged()
```

getActivationDate

public ActivationDate getActivationDate()

hasActivationDateChanged

public boolean hasActivationDateChanged()

getExpirationDate

public ExpirationDate getExpirationDate()
                                 throws OrderConfigurationException

Throws:: OrderConfigurationException

hasExpirationDateChanged

public boolean hasExpirationDateChanged()

getAccount
```
public Account getAccount()
```

hasAccountChanged
```
public boolean hasAccountChanged()
```

getBenchmarkType
```
public String getBenchmarkType()
```

hasBenchmarkTypeChanged

public boolean hasBenchmarkTypeChanged()

getBuySell
```
public BuySell getBuySell()
```

hasBuySellChanged
```
public boolean hasBuySellChanged()
```

getDealtCurrency
```
public String getDealtCurrency()
```

hasDealtCurrencyChanged

public boolean hasDealtCurrencyChanged()

getCurrencyPair
```
public String getCurrencyPair()
```

hasCurrencyPairChanged

public boolean hasCurrencyPairChanged()

getExecutionType

public ExecutionType getExecutionType()

hasExecutionTypeChanged

public boolean hasExecutionTypeChanged()

getFillRate
```
public String getFillRate()
```

hasFillRateChanged
```
public boolean hasFillRateChanged()
```

getRemarks
```
public String getRemarks()
```

hasRemarksChanged
```
public boolean hasRemarksChanged()
```

getMemo
```
public String getMemo()
```

hasMemoChanged
```
public boolean hasMemoChanged()
```

getPreviousOrder
```
public Order getPreviousOrder()
```

hasOrderChanged
```
public boolean hasOrderChanged()
```

hasOrderEditableFieldsChanged

public boolean hasOrderEditableFieldsChanged()

hasFieldChanged

public boolean hasFieldChanged(String fieldName)

toString
```
public String toString()
```
Overrides:

toString in class Object

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

Class Order

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLegId

getOrderId

getFields

getEditableFields

getField

getAlertTypes

hasAlertTypesChanged

getAmount

hasAmountChanged

getActivationDate

hasActivationDateChanged

getExpirationDate

hasExpirationDateChanged

getAccount

hasAccountChanged

getBenchmarkType

hasBenchmarkTypeChanged

getBuySell

hasBuySellChanged

getDealtCurrency

hasDealtCurrencyChanged

getCurrencyPair

hasCurrencyPairChanged

getExecutionType

hasExecutionTypeChanged

getFillRate

hasFillRateChanged

getRemarks

hasRemarksChanged

getMemo

hasMemoChanged

getPreviousOrder

hasOrderChanged

hasOrderEditableFieldsChanged

hasFieldChanged

toString

equals

hashCode