com.caplin.motif.fx.blotter.message

Class HistoricItemMessage.Builder

java.lang.Object

com.caplin.motif.fx.blotter.message.FXBaseBlotterItemMessage.Builder<HistoricItemMessage.Builder>

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

All Implemented Interfaces:

BlotterMessageBuilder

Direct Known Subclasses:

ExecutionItemMessage.Builder

Enclosing class:

HistoricItemMessage

public static class HistoricItemMessage.Builder
extends FXBaseBlotterItemMessage.Builder<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.FXBaseBlotterItemMessage.Builder

itemId, record, username

Constructor Summary

Constructors

Constructor and Description
Builder(String username, String itemId, com.caplin.datasource.messaging.record.GenericMessage record) Deprecated. scheduled for removal. Do not use this constructor, see class javadoc for guidance on how to invoke this builder.

Method Summary

Modifier and Type	Method and Description
HistoricItemMessage.Builder	allocationStatus(String allocationStatus) Sets the allocation status
HistoricItemMessage	build() Builds the HistoricItemMessage
HistoricItemMessage.Builder	farAllInRate(String allInRate) Sets the far all in rate
HistoricItemMessage.Builder	farAmount(String amount) Sets the far amount
HistoricItemMessage.Builder	farBuySell(BuySell buySell) Sets the far BuySell
HistoricItemMessage.Builder	farContraAmount(String contraAmount) Sets the far contra amount
HistoricItemMessage.Builder	farPips(String pips) Sets the far fwd pips
HistoricItemMessage.Builder	farSettlementDate(String settlementDate) Sets the far settlement date
HistoricItemMessage.Builder	farTenor(Tenor tenor) Sets the far tenor
HistoricItemMessage.Builder	nearAllInRate(String allInRate) Sets the all in rate
HistoricItemMessage.Builder	nearAmount(String amount) Sets the amount
HistoricItemMessage.Builder	nearContraAmount(String contraAmount) Sets the near contra amount
HistoricItemMessage.Builder	nearPips(String pips) Sets the near forward pips
HistoricItemMessage.Builder	nearSettlementDate(String settlementDate) Sets the near settlement date
HistoricItemMessage.Builder	nearStartDate(String nearStartDate) Sets the start date for a time option.
HistoricItemMessage.Builder	nearTenor(Tenor tenor) Sets the near tenor
HistoricItemMessage.Builder	spotRate(String rate) Sets the spot rate
HistoricItemMessage.Builder	status(String status) Sets the status
HistoricItemMessage.Builder	swapPips(String pips) Sets the swap pips

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

account, addField, addFieldAndReturnThis, currencyPair, dealtCurrency, executionDateTime, nearBuySell, orderID, submittedBy, submittedFor, tradeDate, tradeID, tradingType

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

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

Deprecated. scheduled for removal. Do not use this constructor, see class javadoc for guidance on how to invoke this builder.

Method Detail

spotRate

public HistoricItemMessage.Builder spotRate(String rate)

Sets the spot rate

Parameters:

rate - The spot rate

Returns:

The builder, to allow chaining.

nearAmount

public HistoricItemMessage.Builder nearAmount(String amount)

Sets the amount

Parameters:

amount - The amount

Returns:

The builder, to allow chaining.

nearAllInRate

public HistoricItemMessage.Builder nearAllInRate(String allInRate)

Sets the all in rate

Parameters:

allInRate - The all in rate

Returns:

The builder, to allow chaining.

nearPips

public HistoricItemMessage.Builder nearPips(String pips)

Sets the near forward pips

Parameters:

pips - the near fwd pips

Returns:

The builder, to allow chaining.

nearContraAmount

public HistoricItemMessage.Builder nearContraAmount(String contraAmount)

Sets the near contra amount

Parameters:

contraAmount - near contra amount

Returns:

The builder, to allow chaining.

nearSettlementDate

public HistoricItemMessage.Builder nearSettlementDate(String settlementDate)

Sets the near settlement date

Parameters:

settlementDate - The near settlement date

Returns:

The builder, to allow chaining.

nearStartDate

public HistoricItemMessage.Builder nearStartDate(String nearStartDate)

Sets the start date for a time option.

Parameters:

nearStartDate - The start date.

Returns:

The builder, to allow chaining.

nearTenor

public HistoricItemMessage.Builder nearTenor(Tenor tenor)

Sets the near tenor

Parameters:

tenor - The near tenor

Returns:

The builder, to allow chaining.

farBuySell

public HistoricItemMessage.Builder farBuySell(BuySell buySell)

Sets the far BuySell

Parameters:

buySell - The far BuySell

Returns:

The builder, to allow chaining.

farAmount

public HistoricItemMessage.Builder farAmount(String amount)

Sets the far amount

Parameters:

amount - The far amount

Returns:

The builder, to allow chaining.

farAllInRate

public HistoricItemMessage.Builder farAllInRate(String allInRate)

Sets the far all in rate

Parameters:

allInRate - The far all in rate

Returns:

The builder, to allow chaining.

farPips

public HistoricItemMessage.Builder farPips(String pips)

Sets the far fwd pips

Parameters:

pips - The far fwd pips

Returns:

The builder, to allow chaining.

farContraAmount

public HistoricItemMessage.Builder farContraAmount(String contraAmount)

Sets the far contra amount

Parameters:

contraAmount - The far contra amount

Returns:

The builder, to allow chaining.

farSettlementDate

public HistoricItemMessage.Builder farSettlementDate(String settlementDate)

Sets the far settlement date

Parameters:

settlementDate - The far settlement date

Returns:

The builder, to allow chaining.

farTenor

public HistoricItemMessage.Builder farTenor(Tenor tenor)

Sets the far tenor

Parameters:

tenor - The far tenor

Returns:

The builder, to allow chaining.

swapPips

public HistoricItemMessage.Builder swapPips(String pips)

Sets the swap pips

Parameters:

pips - The swap pips

Returns:

The builder, to allow chaining.

status

public HistoricItemMessage.Builder status(String status)

Sets the status

Parameters:

status - The status

Returns:

The builder, to allow chaining.

allocationStatus

public HistoricItemMessage.Builder allocationStatus(String allocationStatus)

Sets the allocation status

Parameters:

allocationStatus - The allocation status

Returns:

The builder, to allow chaining.

build

public HistoricItemMessage build()

Builds the HistoricItemMessage

Specified by:

build in interface BlotterMessageBuilder

Overrides:

build in class FXBaseBlotterItemMessage.Builder<HistoricItemMessage.Builder>

Returns:

an object of type FXBaseBlotterItemMessage