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

Class TradeConfPartsDef.CommonTradeConfirmationFields.Builder

    • Method Detail

      • toString

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

      • setDealtCurrency

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDealtCurrency​(@NotNull
                                                                                         @NotNull java.lang.String dealtCurrency,
                                                                                         boolean isEditable,
                                                                                         boolean isRisk)
        Parameters:
        dealtCurrency - e.g. GBP
        Returns:
        The currency of the Amount of a trade or order.

      • setSpotMidRate

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotMidRate​(@NotNull
                                                                                       @NotNull java.math.BigDecimal spotMidRate)
        Parameters:
        spotMidRate - e.g. 1.08345
        Returns:
        The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

      • setSpotMidRate

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setSpotMidRate​(@NotNull
                                                                                       @NotNull java.lang.String spotMidRate)
        Parameters:
        spotMidRate - e.g. 1.08345
        Returns:
        The mid rate between the SpotAskRate and SpotBidRate. Note that this will not always be precisely between.

      • setAccount

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAccount​(@NotNull
                                                                                   @NotNull java.lang.String account,
                                                                                   boolean isEditable)
        Parameters:
        account - e.g. Garfields|GARF
        Returns:
        The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

      • setAccount

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAccount​(@NotNull
                                                                                   @NotNull java.lang.String account)
        Parameters:
        account - e.g. Garfields|GARF
        Returns:
        The account a trade or order has been submitted against. The format is <description>|<name> or <name>|<name>

      • setTraderUsername

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTraderUsername​(@NotNull
                                                                                          @NotNull java.lang.String traderUsername)
        Parameters:
        traderUsername - e.g. sales_trader@novobank.co.za
        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.

      • setTOBOUser

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser​(@NotNull
                                                                                    @NotNull java.lang.String tOBOUser,
                                                                                    boolean isEditable,
                                                                                    boolean isRisk)
        Parameters:
        tOBOUser - e.g. client@customer.co.za
        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.

      • setTOBOUser

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTOBOUser​(@NotNull
                                                                                    @NotNull java.lang.String tOBOUser)
        Parameters:
        tOBOUser - e.g. client@customer.co.za
        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.

      • setEntityId

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEntityId​(@NotNull
                                                                                    @NotNull java.lang.String entityId)
        Parameters:
        entityId - e.g. CUSTONE
        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.

      • setEntityDescription

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setEntityDescription​(@NotNull
                                                                                             @NotNull java.lang.String entityDescription)
        Parameters:
        entityDescription - e.g. Customer 1
        Returns:
        The description of a trade on behalf of entity.

      • setAssetType

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAssetType​(@NotNull
                                                                                     @NotNull java.lang.String assetType)
        Parameters:
        assetType - e.g. FX
        Returns:
        A grouping of investments that exhibit similar characteristics and are subject to the same laws and regulations. Supported asset types are [FX, PM]

      • setTradingType

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTradingType​(@NotNull
                                                                                       @NotNull java.lang.String tradingType)
        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.

      • setDeliverableType

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDeliverableType​(@NotNull
                                                                                           @NotNull java.lang.String deliverableType)
        Returns:
        Caplin supported values are [DELIVERABLE, NON_DELIVERABLE]. Determines whether trade is deliverable or not (for ndfs etc)

      • setDigitsBeforePips

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDigitsBeforePips​(int digitsBeforePips)
        Parameters:
        digitsBeforePips - e.g. 2
        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 field 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.

      • setDigitsBeforePips

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setDigitsBeforePips​(@NotNull
                                                                                            @NotNull java.lang.String digitsBeforePips)
        Parameters:
        digitsBeforePips - e.g. 2
        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 field 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.

      • setNumberOfPips

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNumberOfPips​(int numberOfPips)
        Parameters:
        numberOfPips - e.g. 2
        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.

      • setNumberOfPips

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setNumberOfPips​(@NotNull
                                                                                        @NotNull java.lang.String numberOfPips)
        Parameters:
        numberOfPips - e.g. 2
        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.

      • setWarningMessage

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setWarningMessage​(@NotNull
                                                                                          @NotNull java.lang.String warningMessage)
        Parameters:
        warningMessage - e.g. You do not have sufficient credit for EUR
        Returns:
        The message to display for any warnings regarding a quote request

      • setCostAmount

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostAmount​(@NotNull
                                                                                      @NotNull java.math.BigDecimal costAmount)
        Parameters:
        costAmount - e.g. 12412891.31
        Returns:
        The actual transactional cost of performing the trade to the client in the home currency

      • setCostAmount

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostAmount​(@NotNull
                                                                                      @NotNull java.lang.String costAmount)
        Parameters:
        costAmount - e.g. 12412891.31
        Returns:
        The actual transactional cost of performing the trade to the client in the home currency

      • setCostCurrency

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostCurrency​(@NotNull
                                                                                        @NotNull java.lang.String costCurrency)
        Parameters:
        costCurrency - e.g. GBP
        Returns:
        The currency that the cost is displayed in, this could be any currency but will typically be set to the home currency

      • setCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostCurrencyDPS​(@NotNull
                                                                                           @NotNull java.lang.String costCurrencyDPS)
        Parameters:
        costCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setCostPercentage

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostPercentage​(@NotNull
                                                                                          @NotNull java.math.BigDecimal costPercentage)
        Parameters:
        costPercentage - e.g. 13.56
        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%.

      • setCostPercentage

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setCostPercentage​(@NotNull
                                                                                          @NotNull java.lang.String costPercentage)
        Parameters:
        costPercentage - e.g. 13.56
        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%.

      • setContraCostAmount

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostAmount​(@NotNull
                                                                                            @NotNull java.math.BigDecimal contraCostAmount)
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • setContraCostAmount

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostAmount​(@NotNull
                                                                                            @NotNull java.lang.String contraCostAmount)
        Returns:
        The actual transactional cost of performing the trade to the client on the contra currency

      • setContraCostCurrency

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostCurrency​(@NotNull
                                                                                              @NotNull java.lang.String contraCostCurrency)
        Parameters:
        contraCostCurrency - e.g. GBP
        Returns:
        The contra currency that the cost is displayed in

      • setContraCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostCurrencyDPS​(int contraCostCurrencyDPS)
        Parameters:
        contraCostCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setContraCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostCurrencyDPS​(@NotNull
                                                                                                 @NotNull java.lang.String contraCostCurrencyDPS)
        Parameters:
        contraCostCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setContraCostPercentage

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostPercentage​(@NotNull
                                                                                                @NotNull java.math.BigDecimal contraCostPercentage)
        Parameters:
        contraCostPercentage - e.g. 13.56
        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%.

      • setContraCostPercentage

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraCostPercentage​(@NotNull
                                                                                                @NotNull java.lang.String contraCostPercentage)
        Parameters:
        contraCostPercentage - e.g. 13.56
        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%.

      • setServiceCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceCostCurrencyDPS​(int serviceCostCurrencyDPS)
        Parameters:
        serviceCostCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setServiceCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceCostCurrencyDPS​(@NotNull
                                                                                                  @NotNull java.lang.String serviceCostCurrencyDPS)
        Parameters:
        serviceCostCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setServiceContraCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceContraCostCurrencyDPS​(int serviceContraCostCurrencyDPS)
        Parameters:
        serviceContraCostCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setServiceContraCostCurrencyDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setServiceContraCostCurrencyDPS​(@NotNull
                                                                                                        @NotNull java.lang.String serviceContraCostCurrencyDPS)
        Parameters:
        serviceContraCostCurrencyDPS - e.g. 2
        Returns:
        The number of decimal places to display after the decimal point.

      • setAllocationSettlementDateOptions

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setAllocationSettlementDateOptions​(@NotNull
                                                                                                           @NotNull java.lang.String allocationSettlementDateOptions)
        Parameters:
        allocationSettlementDateOptions - e.g. ORIGINAL,EARLIER,LATER
        Returns:
        Comma-separated list, defines available settlement dates for an allocation.

      • setContraAmountDPS

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setContraAmountDPS​(@NotNull
                                                                                           @NotNull java.lang.String contraAmountDPS)
        Parameters:
        contraAmountDPS - e.g. 2
        Returns:
        The precision for a specified currency pair and contra currency

      • setPriceSource

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setPriceSource​(@NotNull
                                                                                       @NotNull java.lang.String priceSource)
        Parameters:
        priceSource - e.g. st1@caplin.com
        Returns:
        Identifies the person or system that priced the trade.

      • setTags

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTags​(@NotNull
                                                                                @NotNull java.lang.String tags)
        Parameters:
        tags - e.g. method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}
        Returns:
        Tags for a trade.

      • setTags

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setTags​(@NotNull
                                                                                @NotNull java.util.List<Tag> tags)
        Parameters:
        tags - e.g. method={'import':'static com.caplin.motif.fx.config.definitions.common.Tag','name':'Arrays.asList'}
        Returns:
        Tags for a trade.

      • setClientAgreementDateTime

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime​(@NotNull
                                                                                                   @NotNull java.time.Instant clientAgreementDateTime,
                                                                                                   boolean isEditable)
        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

      • setClientAgreementDateTime

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime​(@NotNull
                                                                                                   @NotNull java.time.Instant clientAgreementDateTime)
        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

      • setClientAgreementDateTime

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime​(@NotNull
                                                                                                   @NotNull java.lang.String clientAgreementDateTime,
                                                                                                   boolean isEditable)
        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

      • setClientAgreementDateTime

        @NotNull
public @NotNull TradeConfPartsDef.CommonTradeConfirmationFields.Builder setClientAgreementDateTime​(@NotNull
                                                                                                   @NotNull java.lang.String clientAgreementDateTime)
        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