com.caplin.motif.fx.blotter.message

Class HistoricItemMessage

java.lang.Object

com.caplin.motif.fx.blotter.message.FXBlotterItemMessage

com.caplin.motif.fx.blotter.message.FXBaseBlotterItemMessage

com.caplin.motif.fx.blotter.message.HistoricItemMessage

Direct Known Subclasses:

ExecutionItemMessage

public class HistoricItemMessage
extends FXBaseBlotterItemMessage

Instances of this class represent a Record Item for the Historic Blotter

Instances of this class should be created using the HistoricItemMessage.Builder, this builder should obtained by invoking one of the following methods:

• FXBlotterItemMessageFactory<HistoricItemMessage.Builder>newItemBuilder(String, String)
• FXCachedBlotterMessage<HistoricItemMessage.Builder>newItemBuilder(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HistoricItemMessage.Builder Use this class as parameter T when invoking FXBlotterItemMessageFactory.newItemBuilder(String, String) or FXCachedBlotterMessage.newItemBuilder(String)

Field Summary

Fields inherited from class com.caplin.motif.fx.blotter.message.FXBlotterItemMessage

itemId, record, username

Constructor Summary

Constructors

Constructor and Description
HistoricItemMessage(String username, String itemId, com.caplin.datasource.messaging.record.GenericMessage message) Deprecated. You should not be creating instances of this class. Please see class javadoc to see how the builder for this class is to be obtained.

Method Summary

Modifier and Type	Method and Description
static HistoricItemMessage.Builder	builder(String username, String itemId, com.caplin.datasource.messaging.record.GenericMessage message) Creates a builder from the parameters provided.
String	getAllocationStatus() Returns the allocation status
String	getFarAllInRate() Returns the far all-in rate
String	getFarAmount() Returns the far amount
String	getFarBuySell() Returns the far BuySell
String	getFarContraAmount() Returns The far contra amount
String	getFarPips() Returns The far pips
String	getFarSettlementDate() Returns the far settlement date
String	getFarTenor() Returns the far tenor
String	getNearAllInRate() Returns the near all in rate
String	getNearAmount() Returns the near amount
String	getNearContraAmount() Returns the near contra amount
String	getNearPips() Returns the near pips
String	getNearSettlementDate() Returns the settlement date for the near leg.
String	getNearStartDate() Returns the start date for a time option.
String	getNearTenor() Returns the near tenor
String	getSpotRate() Returns the spot rate
String	getStatus() Returns the status
String	getSwapPips() Returns the swap pips

Methods inherited from class com.caplin.motif.fx.blotter.message.FXBaseBlotterItemMessage

getAccount, getCurrencyPair, getDealtCurrency, getExecutionDateTime, getNearBuySell, getOrderID, getSubmittedBy, getSubmittedFor, getTradeDate, getTradeID, getTradingType

Methods inherited from class com.caplin.motif.fx.blotter.message.FXBlotterItemMessage

copyOf, getField, getFields, getItemID, getRecord, getUsername, isImage, setImage, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoricItemMessage

@Deprecated
public HistoricItemMessage(String username,
                                       String itemId,
                                       com.caplin.datasource.messaging.record.GenericMessage message)

Deprecated. You should not be creating instances of this class. Please see class javadoc to see how the builder for this class is to be obtained.

Parameters:

username - The username to be used in creating the subject for this item

itemId - The id to be used in creating the subject for this item

message - The underly DataSource message

Method Detail

builder

public static HistoricItemMessage.Builder builder(String username,
                                                  String itemId,
                                                  com.caplin.datasource.messaging.record.GenericMessage message)

Creates a builder from the parameters provided. You should not be creating the builder using this method. Please refer to the class javadoc for this class to see how to obtain the builder correctly.

Parameters:

username - The username to be used in creating the subject for this item

itemId - The id to be used in creating the subject for this item

message - The underly DataSource message

Returns:

The builder

getSpotRate

public String getSpotRate()

Returns the spot rate

Returns:

The spot rate

getNearAmount

public String getNearAmount()

Returns the near amount

Returns:

The near amount

getNearAllInRate

public String getNearAllInRate()

Returns the near all in rate

Returns:

The near all in rate

getNearPips

public String getNearPips()

Returns the near pips

Returns:

The near pips

getNearContraAmount

public String getNearContraAmount()

Returns the near contra amount

Returns:

The near contra amount

getNearStartDate

public String getNearStartDate()

Returns the start date for a time option.

Returns:

The start date.

getNearSettlementDate

public String getNearSettlementDate()

Returns the settlement date for the near leg.

Returns:

The near settlement date.

getNearTenor

public String getNearTenor()

Returns the near tenor

Returns:

The near Tenor

getFarAmount

public String getFarAmount()

Returns the far amount

Returns:

The far amount

getFarAllInRate

public String getFarAllInRate()

Returns the far all-in rate

Returns:

The far all-in rate

getFarPips

public String getFarPips()

Returns The far pips

Returns:

The far pips

getFarContraAmount

public String getFarContraAmount()

Returns The far contra amount

Returns:

The far contra amount

getFarTenor

public String getFarTenor()

Returns the far tenor

Returns:

The far tenor

getFarSettlementDate

public String getFarSettlementDate()

Returns the far settlement date

Returns:

The far settlement date

getFarBuySell

public String getFarBuySell()

Returns the far BuySell

Returns:

The far BuySell

getSwapPips

public String getSwapPips()

Returns the swap pips

Returns:

The swap pips

getStatus

public String getStatus()

Returns the status

Returns:

The status

getAllocationStatus

public String getAllocationStatus()

Returns the allocation status

Returns:

The allocation status