Caplin Systems - OrderStrategy (FX Integration API Documentation)

All Known Implementing Classes:

IfDoneOCOStrategy, IfDoneStrategy, IfTimeoutStrategy, MotifOrderStrategy, OCOStrategy, SingleStrategy
```
public interface OrderStrategy
```
An OrderStrategy instance encapsulates the order strategy that the client wants to execute.

If the strategy is a multi-leg order, than it contain the list of orders within it for each leg.

Method Summary

Methods
Modifier and Type	Method and Description
`Account`	`getAccount()` Returns the client account to which this order strategy should be executed for.
`ActivationDate`	`getActivationDate()` Returns the date on which the order strategy should be activated.
`Set<AlertType>`	`getAlertTypes()` Returns the set of `AlertType` of the order strategy.
`List<Order>`	`getChildOrders()` Returns the list of orders representing the legs of the order strategy.
`String`	`getCurrencyPair()` Returns the currency pair of the order strategy.
`ExpirationDate`	`getExpirationDate()` Returns the date on which the order strategy should expire.
`OrderPendingAcceptResponder`	`getPendingAcceptResponder()` Returns the responder for responding to events from the `PendingAccept` state.
`OrderQueuedResponder`	`getQueuedResponder()` Returns the responder for responding to events from the `Queued` state.
`String`	`getRemarks()` Returns the remarks on the order strategy.
`String`	`getRequestID()` The client generated ID of the order strategy to be used in tracking the order in the backend trading system.
`OrderSubmittedResponder`	`getSubmittedResponder()` Returns the responder for responding to events from the `Submitted` state.
`String`	`getTOBOUser()` Returns the trade on behalf of user.
`TradingSubProtocol`	`getTradingSubProtocol()` The trading sub protocol, used to determine small variations of OrderStrategy, should be `TradingSubProtocol.NONE` for standard orders.
`StrategyType`	`getType()` Returns the `StrategyType` of the order strategy.
`String`	`getUsername()` Returns the client username for which this order strategy will be executed for.

- Method Detail
  - getTradingSubProtocol
```
TradingSubProtocol getTradingSubProtocol()
```
    The trading sub protocol, used to determine small variations of OrderStrategy, should be TradingSubProtocol.NONE for standard orders.
    
    Returns:
    The trading sub protocol
  - getRequestID
```
String getRequestID()
```
    The client generated ID of the order strategy to be used in tracking the order in the backend trading system.
    
    Returns:
    The client generated ID.
  - getUsername
```
String getUsername()
```
    Returns the client username for which this order strategy will be executed for.
    
    Returns:
    The client username.
  - getTOBOUser
```
String getTOBOUser()
```
    Returns the trade on behalf of user.
    
    Returns:
    The trade on behalf of user.
  - getAccount
```
Account getAccount()
```
    Returns the client account to which this order strategy should be executed for.
    
    Returns:
    The client account.
  - getActivationDate
```
ActivationDate getActivationDate()
```
    Returns the date on which the order strategy should be activated.
    
    Returns:
    The date on which the order strategy should be activated.
  - getExpirationDate
```
ExpirationDate getExpirationDate()
```
    Returns the date on which the order strategy should expire.
    
    Returns:
    The expiration date.
  - getChildOrders
```
List<Order> getChildOrders()
```
    Returns the list of orders representing the legs of the order strategy.
    
    Returns:
    The list of orders strategy.
  - getType
```
StrategyType getType()
```
    Returns the StrategyType of the order strategy.
    
    Returns:
    The strategy type of the order strategy.
  - getAlertTypes
```
Set<AlertType> getAlertTypes()
```
    Returns the set of AlertType of the order strategy.
    
    Returns:
    The set of alert types.
  - getCurrencyPair
```
String getCurrencyPair()
```
    Returns the currency pair of the order strategy.
    
    Returns:
    The currency pair.
  - getRemarks
```
String getRemarks()
```
    Returns the remarks on the order strategy.
    
    Returns:
    The remarks.
  - getSubmittedResponder
```
OrderSubmittedResponder getSubmittedResponder()
```
    Returns the responder for responding to events from the Submitted state.
    
    Returns:
    The Submitted Responder
  - getQueuedResponder
```
OrderQueuedResponder getQueuedResponder()
```
    Returns the responder for responding to events from the Queued state.
    
    Returns:
    The Queued Responder.
  - getPendingAcceptResponder
```
OrderPendingAcceptResponder getPendingAcceptResponder()
```
    Returns the responder for responding to events from the PendingAccept state.
    
    Returns:
    The Pending Activation.

Interface OrderStrategy

Method Summary

Method Detail

getTradingSubProtocol

getRequestID

getUsername

getTOBOUser

getAccount

getActivationDate

getExpirationDate

getChildOrders

getType

getAlertTypes

getCurrencyPair

getRemarks

getSubmittedResponder

getQueuedResponder

getPendingAcceptResponder