Caplin Systems - FXTradeLeg (FX Integration API Documentation)

java.lang.Object
- com.caplin.motif.fx.trading.FXTradeLeg

Direct Known Subclasses:

BlockTradeLeg, FXExecutionTradeLeg
```
public abstract class FXTradeLeg
extends Object
```
Represents a leg within an FX Trade.

See Also:

FXExecution.getNearLeg(), FXExecution.getFarLeg()

Field Summary

Fields
Modifier and Type Field and Description

protected String legId

protected com.caplin.trading.Trade trade

Fields
Modifier and Type	Field and Description
`protected String`	`legId`
`protected com.caplin.trading.Trade`	`trade`

Constructor Summary

Constructors
Constructor and Description
`FXTradeLeg(com.caplin.trading.Trade trade, String legId)` Constructs the FXTradeLeg which wraps around the underlying trading datasource trade object and provides basic convenience methods to obtain information about the trade.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Account`	`getAccount()` Returns the account that this trade should be booked against.
`abstract String`	`getAmount()` Returns the amount at which the leg should be executed.
`abstract String`	`getBaseCurrency()` Returns the base currency of the currency pair.
`abstract String`	`getCaption()` Returns the NDF text attached to the quote being executed, this is an additional piece of text that is found on an quote that is for an NDF currency pair, for when executing a Non Deliverable Forward.
`abstract String`	`getCurrencyPair()` Returns the currency pair that this trade should be executed against.
`String`	`getCustomField(String fieldName)` Returns a field not provided by the getters that was set on the trade.
`abstract String`	`getDealtCurrency()` Returns the currency that the amount denominates.
`abstract String`	`getFixingDate()` Returns the fixing date, this is an additional date to the settlement date, when executing a Non Deliverable Forward, this is usually two business days before the settlement date.
`String`	`getLegId()` The Id of the leg
`abstract String`	`getSettlementDate()` Returns the settlement date at which the leg should be executed.
`abstract String`	`getStartDate()` Returns the start date for a time option.
`abstract Tenor`	`getStartTenor()` Returns the tenor at which the start date for a time option should be submitted against.
`abstract FXSwapType`	`getSwapType()` If the submitted trade is a swap trade, this method will return the swap type (either Spot Fwd Swap or Fwd Fwd Swap).
`abstract Tenor`	`getTenor()` Returns the tenor at which the leg should be executed.
`abstract String`	`getTermCurrency()` Returns the term currency of the currency pair.
`abstract FXTradingType`	`getTradingType()` Returns the type of trade that should be executed.
`String`	`toString()`

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

- Field Detail
  - legId
```
protected final String legId
```
  - trade
```
protected final com.caplin.trading.Trade trade
```
- Constructor Detail
  - FXTradeLeg
```
public FXTradeLeg(com.caplin.trading.Trade trade,
                  String legId)
```
    Constructs the FXTradeLeg which wraps around the underlying trading datasource trade object and provides basic convenience methods to obtain information about the trade.
    
    Parameters:
    
    trade - The underlying trading datasource trade object.
    
    legId - The leg of the trade this object will refer to.
- Method Detail
  - getLegId
```
public String getLegId()
```
    The Id of the leg
    
    Returns:
    
    The Id of the leg
  - getCustomField
```
public String getCustomField(String fieldName)
```
    Returns a field not provided by the getters that was set on the trade.
    
    Parameters:
    
    fieldName - The name of the custom field
    
    Returns:
    
    The value of the custom field
  - getStartTenor
```
public abstract Tenor getStartTenor()
```
    Returns the tenor at which the start date for a time option should be submitted against. If this is a broken date, then Tenor._BROKEN will be returned. In this case, you should retrieve the settlement date from getStartDate().
    
    Returns:
    
    The start tenor for the leg.
  - getStartDate
```
public abstract String getStartDate()
```
    Returns the start date for a time option. This will only be populated if the trade is submitted as a time option.
    
    Returns:
    
    The start date.
  - getAmount
```
public abstract String getAmount()
```
    Returns the amount at which the leg should be executed.
    
    Returns:
    
    The amount, which may contain decimals.
    
    See Also:
    
    FXExecution.getDealtCurrency()
  - getTradingType
```
public abstract FXTradingType getTradingType()
```
    Returns the type of trade that should be executed.
    
    Returns:
    
    The trade type.
  - getSwapType
```
public abstract FXSwapType getSwapType()
```
    If the submitted trade is a swap trade, this method will return the swap type (either Spot Fwd Swap or Fwd Fwd Swap).
    
    Returns:
    
    The swap type of the trade or null if the trade is not a swap trade.
  - getAccount
```
public abstract Account getAccount()
```
    Returns the account that this trade should be booked against.
    
    Returns:
    
    The account.
  - getTenor
```
public abstract Tenor getTenor()
```
    Returns the tenor at which the leg should be executed. If this is a broken date, then Tenor._BROKEN will be returned. In this case, you should retrieve the settlement date from getSettlementDate().
    
    Returns:
    
    The tenor for the leg.
  - getSettlementDate
```
public abstract String getSettlementDate()
```
    Returns the settlement date at which the leg should be executed. This should only be used if the tenor is Tenor._BROKEN. In the case where the tenor is not broken, this will return the settlement date of the tenor.
    
    Returns:
    
    The settlement date in the form YYYYMMDD
  - getCurrencyPair
```
public abstract String getCurrencyPair()
```
    Returns the currency pair that this trade should be executed against.
    
    Returns:
    
    The currency pair in the format XXXYYY.
  - getBaseCurrency
```
public abstract String getBaseCurrency()
```
    Returns the base currency of the currency pair.
    
    Returns:
    
    The base currency in the format XXX.
  - getTermCurrency
```
public abstract String getTermCurrency()
```
    Returns the term currency of the currency pair.
    
    Returns:
    
    The term currency in the format YYY.
  - getDealtCurrency
```
public abstract String getDealtCurrency()
```
    Returns the currency that the amount denominates.
    
    Returns:
    
    The dealt currency, which may contain sub decimals.
  - getFixingDate
```
public abstract String getFixingDate()
```
    Returns the fixing date, this is an additional date to the settlement date, when executing a Non Deliverable Forward, this is usually two business days before the settlement date.
    
    Returns:
    
    The fixing date in the form YYYYMMDD or null if the trade leg is not for an NDF currency pair
  - getCaption
```
public abstract String getCaption()
```
    Returns the NDF text attached to the quote being executed, this is an additional piece of text that is found on an quote that is for an NDF currency pair, for when executing a Non Deliverable Forward.
    
    Returns:
    
    NDF Text or null if the trade leg is not for an NDF currency pair
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class FXTradeLeg

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

legId

trade

Constructor Detail

FXTradeLeg

Method Detail

getLegId

getCustomField

getStartTenor

getStartDate

getAmount

getTradingType

getSwapType

getAccount

getTenor

getSettlementDate

getCurrencyPair

getBaseCurrency

getTermCurrency

getDealtCurrency

getFixingDate

getCaption

toString