► caplin.trading.trademodel.Trade(String tradingAssetClass, caplin.trading.trademodel.TradeLegFactory tradeLegFactory, caplin.trading.statemachine.StateMachine stateMachine, caplin.trading.trademodel.TradeMessageService tradeMessageService, String tradingProtocol, String tradingType, String assetClass)

Constructs an instance of caplin.trading.trademodel.Trade.

Throws

caplin.core.Error

if any of the specified arguments are omitted or are of the wrong type.

► void addDataFieldChangedListener(caplin.trading.trademodel.DataFieldChangedListener listener, String fieldName, boolean notifyImmediate)

Adds a listener that is called when the specified field is updated.

N.b. If the notifyImmediate flag is set to true and there is a possibility that the field in question does not have a value at the point the listener is registered, then the first call to the caplin.trading.trademodel.DataFieldChangedListener#dataFieldChanged method may be with an undefined value.

See

#addDataFieldsChangedListener

#removeDataFieldChangedListener

► void addDataFieldsChangedListener(caplin.trading.trademodel.DataFieldChangedListener listener, Array fieldNames)

Adds a listener object that is called when any of the specified fields are updated.

See

#addDataFieldChangedListener

#removeDataFieldChangedListener

► void addDerivation(caplin.trading.derivation.Derivation derivation)

Appends a field derivation to the trade model.

Client side field derivations allow new fields to be calculated in response to changes in server-side, or other client-side derived fields.

► void addInvalidServerEventListener(caplin.trading.trademodel.InvalidServerEventListener listener)

Adds a listener that will have its callback method invoked when the server returns data that is somehow invalid. It is expected the client will examine the error and decide on what action to take (e.g. aborting the trade).

See

#removeInvalidServerEventListener

► caplin.trading.trademodel.TradeLeg addLeg(String assetClass)

Creates a new trade leg with the specified asset class.

Throws

caplin.core.Error

if legs cannot be created.

Returns

{caplin.trading.trademodel.TradeLeg} The newly created leg.

► caplin.trading.trademodel.TradeLeg addLegs(String assetClass, Integer count)

Creates a specified number of new trade legs with of the given asset class.

Throws

caplin.core.Error

if legs cannot be created.

Returns

{Array} An array of the newly created leg references.

► void addStateChangedListener(caplin.trading.statemachine.StateChangedListener listener)

Adds a listener that will have its callback method invoked when the state of the trade is updated.

See

#removeStateChangedListener

► void addStructureChangedListener(caplin.trading.trademodel.StructureChangedListener listener)

Adds a listener that will have its callback method invoked when legs are added or removed from the trade.

See

#removeStructureChangedListener

► void addTradeRestoredListener(caplin.trading.restoration.TradeRestoredListener listener)

Adds a listener to listen to trade restored events.

► void addTradingStatusChangedListener(caplin.trading.trademodel.TradingStatusChangedListener listener)

Adds a specified TradingStatusChangedListener to the trade.

The listener will be notified immediately of current trading state.

► void addValidator(String state, caplin.trading.validation.Validator validator)

Adds a validator object that is invoked whenever the trade data is being modified, so it can verify the changes before they are committed.

► void afterLegAdded(caplin.trading.trademodel.TradeLeg leg, int legId)

Invoked immediately after a leg is added to the trade.

This method can be overridden to provide specific functionality for a particular trade type.

► void beforeLegAdded(caplin.trading.trademodel.TradeLeg leg, int legId)

Invoked before a leg is added to the trade.

This method can be overridden to provide specific functionality for a particular trade type. N.b. At the point at which this call is made, the new leg will not yet be available within the trade object!

► String getAccount()

Returns the financial account used for the transfer of funds when the trade is settled.

See

#setAccount

► String getAssetClass()

Returns the type of the financial instrument(s) to be traded — e.g FX, FI, EQUITY or COMMODITIES.

The asset class is only defined at the trade level if all of the trade legs have the same asset class. For exotic trades (cross asset), the asset class is only defined within the leg.

Returns

{String} The instrument's asset class

► caplin.trading.statemachine.State getCurrentState()

Returns the current state of this trade.

► Object getDataAsStructuredMap(Boolean includeLegs)

Takes data from the trade and trade legs and returns it inside a single DataHolder. This is the inverse operation of decodeData.

Returns

{Object} All the trade information as a plain JS object of the form: { fieldData: {}, legsFieldData: [ {}, // L1 field data {}, // L2 field data ... ] }

► Variant getFieldValue(String fieldName)

Returns the field value with the specified name.

Field names follow the java beans naming convention. For any methods getXxx()/setXxx() there should be a field with the corresponding name, 'xxx'.

► int getInitialLegCount(String tradeType)

Returns the initial number of legs to be completed in a trade based on the trade type.

► caplin.trading.trademodel.TradeLeg getLeg(int idx)

Returns the trade leg at the specified index (zero based).

Returns

{caplin.trading.trademodel.TradeLeg} The located trade leg.

► caplin.trading.trademodel.TradeLeg getLegById(int legId)

Returns the trade leg specified by its ID.

Returns

{caplin.trading.trademodel.TradeLeg} The located trade leg.

► Array getLegs()

Returns a copy of the list of trade legs.

To prevent corruption, or change of the list by some external party, a copy of the list is returned, rather than the original list itself.

Returns

{Array} A list of caplin.trading.trademodel.TradeLeg objects.

► int getMaxLegCount(String tradeType)

Returns the maximum number of legs allowed in a trade of the specified trade type.

► String getOverallTimeOut()

Returns the time allowed before the trade will timeout and move to an expired state.

► void getRemainingTimeToTrade()

Returns the time that is left until the trade stops being executable

► String getRequestID()

Returns the unique identifier assigned by the trade subscriber to track this trade instance.

See

#getTradeID

► String getRestorationID()

Returns the ID sent from the server that is used to restore trades.

Returns

{String} The restoration id as sent from the server.

► String getServerFailureMessage()

Returns an error message containing the reason for a failure if the trade is in an error state — caused by a failure in the server or the network.

► String getState()

Returns the current state of the trade.

Returns

{String} The trade's current state

► void getStateMachine()

Returns the state machine associated with this trade.

► void getTradeChannelStatus()

Returns only the status of the trade channel and not the pricing channel. Useful for RFQ which are for trades only.

► String getTradeDate()

The date the trade is/was executed in YYYYMMDD format.

Returns

{String} The trade date

See

#setTradeDate

► String getTradeID()

Returns the unique identifier assigned by the trading system to track this trade instance.

See

#getRequestID

► String getTradingProtocol()

Returns the trading protocol that the trade is being executed with.

The trading protocol defines the set of messages that must be passed between the client and server to execute a trade. The actual definitions of the messages, and how the messages are created and consumed is defined within the state machine.

Common examples of trading protocols are ESP (Executable Streaming Price) and RFQ (Request For Quote).

Returns

{String} An identifier representing the trading protocol used by this trade.

► int getTradingStatus()

Returns a number indicating whether trading and/or pricing is currently available for this Trade or not. Trading is considered to be unavailable when access to the trading system has been lost. Pricing is considered to be unavailable if access to the pricing system has been lost - this may be used to disable trading if the prices are executable.

The possible return values are provided by the caplin.trading.trademodel.TradingStatus enumeration.

Returns

{int} caplin.trading.trademodel.TradingStatus.AVAILABLE if it is possible to trade, caplin.trading.trademodel.TradingStatus.PRICING_STALE if pricing is unavailable, otherwise caplin.trading.trademodel.TradingStatus.UNAVAILABLE.

► String getTradingType()

Returns the trading type that this trade is currently executing — e.g. SPOT, FORWARD or SWAP.

Returns

{String} The trading type

See

#setTradingType

► String getUserTradedOnBehalfOf()

Returns the user this trade will be executed on behalf of.

Returns

{String} The user

See

#setUserTradedOnBehalfOf

► boolean isEventAllowed(String eventName)

Returns true if the specified event name is currently executable, and false otherwise (including if the event is unknown).

Throws

caplin.core.Error

if the event name is not a string.

Returns

{boolean} true if the event is allowed, otherwise false.

► caplin.trading.validation.ValidationResult processClientEvent(String eventName, Map tradeFieldsMap)

This method is called by the client code to request a state transition. The caplin.trading.validation.ValidationResult#getValidationSuccessful method of the result returned by this method indicates whether the transition was successful or not. If the transition was successful the appropriate message will be sent to the trading system. If it failed, the caplin.trading.validation.ValidationResult#getErrors method will return the reason(s) why.

The client code should register itself as a state changed listener to be informed when the state transition occurs using the #addStateChangedListener method.

Please note that if the optional tradeFieldsMap argument is used, the values will be sent to the trading system, however they will not be committed to the trade model.

Throws

caplin.core.Error

if the state transition fails for any reason.

Returns

{caplin.trading.validation.ValidationResult} A ValidationResult that indicates whether the state transition was successful or not.

► void processServerEvent(String eventName, Map serverReturnedData)

This method is called by the trade subscriber when messages are received from the server.

The internal state and the data contained by the Trade are updated to reflect the data sent by the server. If the sent data is invalid then the trade informs any registered listeners (added via #addInvalidServerEventListener) of any problems.

► void removeAllLegs()

Removes all legs from the trade object.

Throws

caplin.core.Error

if the leg cannot be found.

► void removeDataFieldChangedListener(caplin.trading.trademodel.DataFieldChangedListener listener, Array fieldNames)

Removes the previously registered DataFieldChangedListener.

See

#addDataFieldChangedListener

► void removeDataFieldsChangedListener(caplin.trading.trademodel.DataFieldChangedListener listener, Array fieldNames)

Removes a listener object from each of the passed fields.

See

#addDataFieldChangedListener

#removeDataFieldChangedListener

► void removeInvalidServerEventListener(caplin.trading.trademodel.InvalidServerEventListener listener)

Removes the previously registered InvalidServerEventListener.

See

#addInvalidServerEventListener

► void removeLeg(caplin.trading.trademodel.TradeLeg leg)

Removes a leg from the trade object.

Throws

caplin.core.Error

if the leg cannot be found.

► void removeStateChangedListener(caplin.trading.statemachine.StateChangedListener listener)

Removes the previously registered StateChangedListener.

See

#addStateChangedListener

► void removeStructureChangedListener(caplin.trading.trademodel.StructureChangedListener listener)

Removes the previously registered StructureChangedListener.

See

#addStructureChangedListener

► void removeTradeRestoredListener(caplin.trading.restoration.TradeRestoredListener listener)

Removes the specified listener from listening to trade restored events.

► boolean removeTradingStatusChangedListener(caplin.trading.trademodel.TradingStatusChangedListener listener)

Removes the most recently added TradingStatusChangedListener from the trade.

Returns

{boolean} true if the listener has been removed, otherwise false.