Caplin Systems - CustomFieldValues (RET Toolkit API)

java.lang.Object
- com.caplin.motif.fx.ret.common.customfield.CustomFieldValues

```
public class CustomFieldValues
extends java.lang.Object
```
This class is used to store additional fields in a TRAPI order.

CustomFieldValues are stored in the TakerOrderCustom field of a TRAPI order.

This class can be instantiated using the CustomFieldValues.Builder.

See Also:

CustomFieldValuesFactory, CustomFieldValuesSerialiser

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CustomFieldValues.Builder
Helper class that is used to construct a CustomFieldValues object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CustomFieldValues.Builder` Helper class that is used to construct a `CustomFieldValues` object.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`LAST_EDITED_BY`
`static java.lang.String`	`TIME_CONNECTION_RECEIVED`
`static java.lang.String`	`TIME_SETTING_UP_TRADE`
`static java.lang.String`	`TIME_TRADE_RECEIVED`
`static java.lang.String`	`TIME_TRADE_SUBMITTED`
`static java.lang.String`	`TIME_WAITING_FOR_CONNECTION`
`static java.lang.String`	`USERNAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CustomFieldValues.Builder`	`builder()` Returns a new builder that can be used to create a `CustomFieldValues`.
`static CustomFieldValues.Builder`	`builder(CustomFieldValues customFieldValues)` Returns a new builder pre-populated with the values from the specified `CustomFieldValues` that can be used to create a new `CustomFieldValues`.
`java.lang.String`	`getAmount()` Returns the amount.
`AssetClass`	`getAssetClass()` Returns the AssetClass.
`java.lang.String`	`getClientTimePriceClicked()` Returns the time the client clicked on the price.
`java.lang.String`	`getClientTimePriceOnScreen()` Returns the time the price was displayed on the client's screen.
`java.lang.String`	`getFarAmount()` Returns the far amount.
`java.lang.String`	`getLastEditedBy()`
`java.lang.String`	`getNearAmount()` Returns the near amount.
`java.lang.String`	`getQuoteId()` Returns the quote ID.
`java.lang.String`	`getServerTimeConnectionReceived()` Returns the time that the server received a connection.
`java.lang.String`	`getServerTimePriceReceived()` Returns the time on the server that the price was received from RET.
`java.lang.String`	`getServerTimeSettingUpTrade()` Returns the time the server took setting up a trade.
`java.lang.String`	`getServerTimeTradeReceived()` Returns the time on the server that the trade was received.
`java.lang.String`	`getServerTimeTradeSubmitted()` Returns the time on the server that the trade was submitted.
`java.lang.String`	`getServerTimeWaitingForConnection()` Returns the time the server has spent waiting for a connection.
`TradingProtocol`	`getTradingProtocol()` Returns the TradingProtocol.
`java.lang.String`	`getUnit()` Returns the unit.
`java.lang.String`	`getUsername()` Returns the username.
`java.lang.String`	`getValue(java.lang.String key)` Returns the value associated with the given key.
`com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>`	`getValues()` Returns an ImmutableMap containing all of the custom field values.

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

- Field Detail
  - USERNAME
```
public static final java.lang.String USERNAME
```
    See Also:
    
    Constant Field Values
  - TIME_TRADE_RECEIVED
```
public static final java.lang.String TIME_TRADE_RECEIVED
```
    See Also:
    
    Constant Field Values
  - TIME_CONNECTION_RECEIVED
```
public static final java.lang.String TIME_CONNECTION_RECEIVED
```
    See Also:
    
    Constant Field Values
  - TIME_WAITING_FOR_CONNECTION
```
public static final java.lang.String TIME_WAITING_FOR_CONNECTION
```
    See Also:
    
    Constant Field Values
  - TIME_SETTING_UP_TRADE
```
public static final java.lang.String TIME_SETTING_UP_TRADE
```
    See Also:
    
    Constant Field Values
  - TIME_TRADE_SUBMITTED
```
public static final java.lang.String TIME_TRADE_SUBMITTED
```
    See Also:
    
    Constant Field Values
  - LAST_EDITED_BY
```
public static final java.lang.String LAST_EDITED_BY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getUsername
```
public java.lang.String getUsername()
```
    Returns the username.
  - getTradingProtocol
```
public TradingProtocol getTradingProtocol()
```
    Returns the TradingProtocol.
  - getAssetClass
```
public AssetClass getAssetClass()
```
    Returns the AssetClass.
  - getAmount
```
public java.lang.String getAmount()
```
    Returns the amount.
  - getNearAmount
```
public java.lang.String getNearAmount()
```
    Returns the near amount.
  - getFarAmount
```
public java.lang.String getFarAmount()
```
    Returns the far amount.
  - getUnit
```
public java.lang.String getUnit()
```
    Returns the unit.
  - getClientTimePriceOnScreen
```
public java.lang.String getClientTimePriceOnScreen()
```
    Returns the time the price was displayed on the client's screen.
  - getClientTimePriceClicked
```
public java.lang.String getClientTimePriceClicked()
```
    Returns the time the client clicked on the price.
  - getServerTimePriceReceived
```
public java.lang.String getServerTimePriceReceived()
```
    Returns the time on the server that the price was received from RET.
  - getServerTimeTradeReceived
```
public java.lang.String getServerTimeTradeReceived()
```
    Returns the time on the server that the trade was received.
  - getServerTimeConnectionReceived
```
public java.lang.String getServerTimeConnectionReceived()
```
    Returns the time that the server received a connection.
  - getServerTimeWaitingForConnection
```
public java.lang.String getServerTimeWaitingForConnection()
```
    Returns the time the server has spent waiting for a connection.
  - getServerTimeSettingUpTrade
```
public java.lang.String getServerTimeSettingUpTrade()
```
    Returns the time the server took setting up a trade.
  - getServerTimeTradeSubmitted
```
public java.lang.String getServerTimeTradeSubmitted()
```
    Returns the time on the server that the trade was submitted.
  - getQuoteId
```
public java.lang.String getQuoteId()
```
    Returns the quote ID.
  - getLastEditedBy
```
public java.lang.String getLastEditedBy()
```
  - getValue
```
public java.lang.String getValue(java.lang.String key)
```
    Returns the value associated with the given key.
  - getValues
```
public com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> getValues()
```
    Returns an ImmutableMap containing all of the custom field values.
  - builder
```
public static CustomFieldValues.Builder builder(CustomFieldValues customFieldValues)
```
    Returns a new builder pre-populated with the values from the specified CustomFieldValues that can be used to create a new CustomFieldValues.
  - builder
```
public static CustomFieldValues.Builder builder()
```
    Returns a new builder that can be used to create a CustomFieldValues.

Class CustomFieldValues

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USERNAME

TIME_TRADE_RECEIVED

TIME_CONNECTION_RECEIVED

TIME_WAITING_FOR_CONNECTION

TIME_SETTING_UP_TRADE

TIME_TRADE_SUBMITTED

LAST_EDITED_BY

Method Detail

getUsername

getTradingProtocol

getAssetClass

getAmount

getNearAmount

getFarAmount

getUnit

getClientTimePriceOnScreen

getClientTimePriceClicked

getServerTimePriceReceived

getServerTimeTradeReceived

getServerTimeConnectionReceived

getServerTimeWaitingForConnection

getServerTimeSettingUpTrade

getServerTimeTradeSubmitted

getQuoteId

getLastEditedBy

getValue

getValues

builder

builder