Caplin Systems - Strategy (FX Integration API Documentation)

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

```
public class Strategy
extends Object
```
This class represents a Strategy which will consist of one or more orders. Instances of this class should be created by calling StrategyBuilder.build() 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`	`getCurrencyPair()`
`ExpirationDate`	`getExpirationDate()`
`String`	`getField(String field)` Returns the value of the given field.
`Map<String,String>`	`getFields()` Returns the fields directly related to this strategy.
`String`	`getMemo()`
`Order`	`getOrderByLegID(int legID)` Returns the order associated with this strategy that has the provided leg ID.
`List<Order>`	`getOrders()` Returns the set of orders associated with this strategy.
`Strategy`	`getPreviousStrategy()`
`String`	`getRemarks()`
`String`	`getRequestID()`
`String`	`getTOBOUser()`
`StrategyType`	`getType()`
`String`	`getUsername()`
`boolean`	`hasAccountChanged()`
`boolean`	`hasActivationDateChanged()`
`boolean`	`hasAlertTypesChanged()`
`boolean`	`hasCurrencyPairChanged()`
`boolean`	`hasExpirationDateChanged()`
`boolean`	`hasFieldChanged(String fieldName)`
`int`	`hashCode()`
`boolean`	`hasMemoChanged()`
`boolean`	`hasRemarksChanged()`
`boolean`	`hasRequestIDChanged()`
`boolean`	`hasStrategyChanged()`
`boolean`	`hasStrategyEditableFieldsChanged()`
`boolean`	`hasTypeChanged()`
`boolean`	`hasUsernameChanged()`
`String`	`toString()`

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

Method Detail

getField
```
public String getField(String field)
```
Returns the value of the given field.

Parameters:

field - The name of the field to retrieve the value for.

Returns:

the value of the given field.

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

Returns:

the fields directly related to this strategy.

getOrders
```
public List<Order> getOrders()
```
Returns the set of orders associated with this strategy.

Returns:

A map of orders associated with this strategy.

See Also:

Order

getOrderByLegID
```
public Order getOrderByLegID(int legID)
```
Returns the order associated with this strategy that has the provided leg ID.

Parameters:

legID - The leg ID to use for finding the order.

Returns:

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

See Also:

Order

getRequestID
```
public String getRequestID()
```

hasRequestIDChanged
```
public boolean hasRequestIDChanged()
```

getUsername
```
public String getUsername()
```

hasUsernameChanged
```
public boolean hasUsernameChanged()
```

getTOBOUser
```
public String getTOBOUser()
```

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

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

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

hasCurrencyPairChanged

public boolean hasCurrencyPairChanged()

getActivationDate

public ActivationDate getActivationDate()

hasActivationDateChanged

public boolean hasActivationDateChanged()

getExpirationDate

public ExpirationDate getExpirationDate()

hasExpirationDateChanged

public boolean hasExpirationDateChanged()

getType
```
public StrategyType getType()
```

hasTypeChanged
```
public boolean hasTypeChanged()
```

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

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

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

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

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

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

hasStrategyChanged
```
public boolean hasStrategyChanged()
```

hasStrategyEditableFieldsChanged

public boolean hasStrategyEditableFieldsChanged()

getPreviousStrategy
```
public Strategy getPreviousStrategy()
```

hasFieldChanged

public boolean hasFieldChanged(String fieldName)

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

equals in class Object

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

hashCode in class Object

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

toString in class Object

Class Strategy

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getField

getFields

getOrders

getOrderByLegID

getRequestID

hasRequestIDChanged

getUsername

hasUsernameChanged

getTOBOUser

getAccount

hasAccountChanged

getCurrencyPair

hasCurrencyPairChanged

getActivationDate

hasActivationDateChanged

getExpirationDate

hasExpirationDateChanged

getType

hasTypeChanged

getAlertTypes

hasAlertTypesChanged

getRemarks

hasRemarksChanged

getMemo

hasMemoChanged

hasStrategyChanged

hasStrategyEditableFieldsChanged

getPreviousStrategy

hasFieldChanged

equals

hashCode

toString