► caplin.trading.trademodel.TradeLeg(caplin.trading.trademodel.Trade trade, int legId)

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

Throws

caplin.core.Error

if trade is not a valid instance of caplin.trading.trademodel.Trade.

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

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

If it's more convenient it's also possible to add leg field listeners directly on the associated caplin.trading.trademodel.Trade instance, where the given field names must have the leg prefix prepended, e.g. 'L1_Amount' rather than 'Amount'.

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

► 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

► void appendTraceData(Map mTraceData)

Append trace data into the internal data structure, so it can be sent to the server for analysis. This does not fire any listeners or run any derivations.

► void dataFieldsUpdatedBySubscriber(caplin.trading.trademodel.DataHolder fieldData)

This method is a callback method used by the subscriber to notify the leg when new data is received from the server. The field names arriving from the server are not prefixed with the leg number.

► String getAmount()

Returns the number of units of the underlying financial instrument to be traded.

Returns

{String} The number of units

See

#setAmount

► String getAssetClass()

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

Returns

{String} The instrument type

See

#setAssetClass

► Variant getFieldValue(String fieldName)

Returns the field value with the specified name.

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

► String getInstrument()

Returns the financial instrument that is currently being traded on this leg.

The format of the name is dependent on the asset class. Any processing for specific asset classes should be added to subclasses of TradeLeg. The instrument name is generally not understood by Liberator. Liberator requires a subject name that consists of a concatenation of asset class and instrument name.

Returns

{String} The instrument

See

#setInstrument

► caplin.trading.trademodel.Trade getTrade()

Returns the caplin.trading.trademodel.Trade object that this leg is a part of.

Returns

{caplin.trading.trademodel.Trade} The trade

► boolean isPermissioned()

Returns whether the user is permissioned to trade on this leg, based on the results of querying the caplin.services.security.PermissionService singleton.

The permission service is queried based on the instrument that is being traded within the leg (retrieved via #getInstrument) and the the trading protocol being used to perform the trade (retrieved via caplin.trading.trademodel.Trade#getTradingProtocol).

► void removeDataFieldChangedListener(caplin.trading.trademodel.DataFieldChangedListener listener, String fieldName)

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

#removeDataFieldChangedListener

► void removeInstrumentDataSubscriber()

Removes and unsubscribes the leg from the previously registered caplin.trading.trademodel.InstrumentDataSubscriber.

See

#setInstrumentDataSubscriber

► void resume()

Resume a previously suspended indicative data subscription on the trade leg. If there is no indicative data subscription, it does nothing. If this trade leg is not suspended it does nothing.

► void setAmount(String amount)

Sets the number of units of the underlying financial instrument to be traded.

See

#getAmount

► void setAssetClass(String assetClass)

Sets the type of the instrument to be traded — e.g FX, FI, EQUITY or COMMODITIES.

See

#getAssetClass

► void setFieldValue(String fieldName, String sValue)

Sets the value within the trade leg. Initial the trade instance is asked to validate the change. If all is well then the change is made within the leg and the data change listeners are notified (called in response to user input).

► void setInstrument(String instrument)

Sets the financial instrument that will be traded on this leg.

See

#getInstrument

► void setInstrumentDataSubscriber(caplin.trading.trademodel.InstrumentDataSubscriber instrumentDataSubscriber)

Sets the InstrumentDataSubscriber used to be obtain the prices for the instrument.

For certain trade protocols (e.g. ESP) the prices are pre-populated. In this case, when the user initiates the trade the existing price is used.

See

#removeInstrumentDataSubscriber

► void stop()

Stops all operations on the trade leg.

This method should be called when the trade leg is no longer needed as it releases any resources held by the trade leg. This method does not remove listeners that were registered using the #addDataFieldChangedListener or #addDataFieldsChangedListener methods.

Any data associated with the leg will be cleared when this method is called.

► void suspend()

Temporarily suspends the indicative data subscription on the trade leg.

If there is no indicative data subscription, or if the trade leg is already suspended, calling this method has no effect.