Package com.caplin.generated.motif.fx.tradeconfirmation

Class TradeConfPartsDef.CommonTradeConfirmationFields

    • Method Detail

      • getTradeID

        @Nullable
public @Nullable java.lang.String getTradeID()
        Returns:
        A unique identifier for this trade

      • getCurrencyPair

        @Nullable
public @Nullable java.lang.String getCurrencyPair()
        Returns:
        The currency pair for the trade. For example, EURUSD

      • getDealtCurrency

        @Nullable
public @Nullable java.lang.String getDealtCurrency()
        Returns:
        The currency of the Amount of a trade or order.

      • getSpotRate

        @Nullable
public @Nullable java.math.BigDecimal getSpotRate()
        Returns:
        spotRate e.g. 1.08341

      • getSpotMidRate

        @Nullable
public @Nullable java.math.BigDecimal getSpotMidRate()
        Returns:
        The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

      • getSpotRateDPS

        @Nullable
public @Nullable java.lang.Integer getSpotRateDPS()
        Returns:
        The number of decimal places to display after the decimal point.

      • getExecutionDateTime

        @Nullable
public @Nullable java.lang.String getExecutionDateTime()
        Returns:
        executionDateTime e.g. 20160322123621

      • getTradeDate

        @Nullable
public @Nullable java.lang.String getTradeDate()
        Returns:
        tradeDate e.g. 20160314

      • getAccount

        @Nullable
public @Nullable java.lang.String getAccount()
        Returns:
        The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

      • getTraderUsername

        @Nullable
public @Nullable java.lang.String getTraderUsername()
        Returns:
        The user who entered the trade. This may be on behalf of themselves, or on behalf of someone else. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be dealer1@novobank.co.za. If the user client@customer.co.za makes a trade on behalf of themselves it will be client@customer.co.za.

      • getTOBOUser

        @Nullable
public @Nullable java.lang.String getTOBOUser()
        Returns:
        The user the trade is on behalf of. For example, if the logged in user dealer1@novobank.co.za wishes to make a trade on behalf of user client@customer.co.za, then the value of this field will be client@customer.co.za.

      • getFullName

        @Nullable
public @Nullable java.lang.String getFullName()
        Returns:
        The full name of the user the trade is on behalf of

      • getEntityId

        @Nullable
public @Nullable java.lang.String getEntityId()
        Returns:
        The entity the trade is on behalf of. For example, if the logged in user user1@customer.co.za wishes to make a trade on behalf of entity CUSTONE, then the value of this field will be CUSTONE. If this field is absent on a leg then the default entity should be presumed.

      • getEntityDescription

        @Nullable
public @Nullable java.lang.String getEntityDescription()
        Returns:
        The description of a trade on behalf of entity.

      • getAssetType

        @Nullable
public @Nullable java.lang.String getAssetType()
        Returns:
        A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]

      • getTradingType

        @Nullable
public @Nullable java.lang.String getTradingType()
        Returns:
        Caplin supported values are [SPOT, FWD, NDF, NDF_FIXING, NDS, TIME_OPTION, DRAWDOWN, SWAP, BLOCK, PAR_FORWARD]. See the constants defined within com.caplin.motif.fx.trading.FXTradingType for further details.

      • getDeliverableType

        @Nullable
public @Nullable java.lang.String getDeliverableType()
        Returns:
        Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)

      • getDigitsBeforePips

        @Nullable
public @Nullable java.lang.Integer getDigitsBeforePips()
        Returns:
        Precision-related field that tells the client how to display rates. This is the number of digits between the decimal point and the pips (i.e the big digits that the client wants to look at). For most currency pairs the value of this bla will be 2, i.e. for a USDGBP rate of 1.23456 the pips are 45 so there are two digits between the decimal point and the pips. For USDJPY the rate could be 103.256 and the pips are the 25, so in this case the value of DigitsBeforePips should be 0.

      • getNumberOfPips

        @Nullable
public @Nullable java.lang.Integer getNumberOfPips()
        Returns:
        Precision-related field that tells the client how to display rates. This is the number of pips the client wants to look at. Normally this value is 2.

      • getOrderID

        @Nullable
public @Nullable java.lang.String getOrderID()
        Returns:
        The id of the order.

      • getWarningCode

        @Nullable
public @Nullable java.lang.String getWarningCode()
        Returns:
        The code for the warning regarding a quote request.

      • getWarningMessage

        @Nullable
public @Nullable java.lang.String getWarningMessage()
        Returns:
        The message to display for any warnings regarding a quote request

      • getClient

        @Deprecated
@Nullable
public @Nullable java.lang.String getClient()
        Deprecated.
        Returns:
        Client is a duplicate of TOBOUser

      • getCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getCostAmount()
        Returns:
        The actual transactional cost of performing the trade to the client in the home currency

      • getCostCurrency

        @Nullable
public @Nullable java.lang.String getCostCurrency()
        Returns:
        The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency

      • getCostPercentage

        @Nullable
public @Nullable java.math.BigDecimal getCostPercentage()
        Returns:
        Percentage of the overall price which is the transactional cost to the client of performing the trade. This number should be out of 100, where 100.0 represents 100%.

      • getContraCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getContraCostAmount()
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • getContraCostCurrency

        @Nullable
public @Nullable java.math.BigDecimal getContraCostCurrency()
        Returns:
        The contra currency that the cost is displayed in

      • getContraCostPercentage

        @Nullable
public @Nullable java.math.BigDecimal getContraCostPercentage()
        Returns:
        Percentage of the overall price which is the transactional cost to the client of performing the trade in contra currency. This number should be out of 100, where 100.0 represents 100%.

      • getCanAllocate

        @Nullable
public @Nullable java.lang.String getCanAllocate()
        Returns:
        Defines if a user can allocate a trade. Enum of: NONE, FULL, FULL_OR_PARTIAL

      • getAllocationSettlementDateOptions

        @Nullable
public @Nullable java.lang.String getAllocationSettlementDateOptions()
        Returns:
        Comma-separated list, defines available settlement dates for an allocation.

      • getIsAllocated

        @Nullable
public @Nullable java.lang.Boolean getIsAllocated()
        Returns:
        Define if a trade is already allocated or rolled

      • getIsReversible

        @Nullable
public @Nullable java.lang.Boolean getIsReversible()
        Returns:
        Whether a trade can be reversed.

      • getIsAmendable

        @Nullable
public @Nullable java.lang.Boolean getIsAmendable()
        Returns:
        Whether a trade can be amended.

      • getIsCancellable

        @Nullable
public @Nullable java.lang.Boolean getIsCancellable()
        Returns:
        Whether a trade can be cancelled.

      • getCostCurrencyDPS

        @Nullable
public @Nullable java.lang.Integer getCostCurrencyDPS()
        Returns:
        The number of decimal places to display after the decimal point.

      • getRemarks

        @Nullable
public @Nullable java.lang.String getRemarks()
        Returns:
        The text content of a comment left on a leg of a trade or order.

      • getForceReporting

        @Nullable
public @Nullable java.lang.Boolean getForceReporting()
        Returns:
        Indicates whether a trade is flagged for reporting

      • getUTI

        @Nullable
public @Nullable java.lang.String getUTI()
        Returns:
        Unique Transaction Identifier.

      • getBackOfficeID

        @Nullable
public @Nullable java.lang.String getBackOfficeID()
        Returns:
        Back office trade identifier.

      • getPriceSource

        @Nullable
public @Nullable java.lang.String getPriceSource()
        Returns:
        Identifies the person or system that priced the trade.

      • getVenue

        @Nullable
public @Nullable java.lang.String getVenue()
        Returns:
        Where the trade was placed.

      • getPurpose

        @Nullable
public @Nullable java.lang.String getPurpose()
        Returns:
        The purpose of a trade.

      • getTags

        @Nullable
public @Nullable java.lang.String getTags()
        Returns:
        Tags for a trade.

      • getDisplayFields

        @Nullable
public @Nullable java.lang.String getDisplayFields()
        Returns:
        Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.

      • getClientAgreementDateTime

        @Nullable
public @Nullable java.time.Instant getClientAgreementDateTime()
        Returns:
        Optional field that can be used to display the client agreement date time in a trade amend. This field can also be included in the Amend's EditableFields list to allow the user to edit it. This field can be used to allow the user to specify a client agreement time in scenarios where the execution time might have been different

      • getPostTradeType

        @Nullable
public @Nullable java.lang.String getPostTradeType()
        Returns:
        The post-trade action that created this trade. Enum of: ROLL_BACK, ROLL_FORWARD, ALLOCATION

      • getOriginalTradeID

        @Nullable
public @Nullable java.lang.String getOriginalTradeID()
        Returns:
        TradeID of the trade that this trade was created from.

      • getFields

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.lang.String> getFields()
        Specified by:
        getFields in interface Message

      • getFieldFlags

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFieldFlags()
        Specified by:
        getFieldFlags in interface BuilderMessage
        Returns:
        Get the flags for all fields.

      • getFlagFields

        @NotNull
public @NotNull java.util.Map<java.lang.String,​java.util.Collection<java.lang.String>> getFlagFields()
        Specified by:
        getFlagFields in interface BuilderMessage
        Returns:
        Get the fields for all flags.

      • toString

        @NotNull
public @NotNull java.lang.String toString()
        Overrides:
        toString in class java.lang.Object