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

Class TradeConfPartsDef.LegTradeConfirmationFields

    • Method Detail

      • getTradeID

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

      • getAllInRate

        @Nullable
public @Nullable java.math.BigDecimal getAllInRate()
        Returns:
        allInRate e.g. 1.091790

      • getAllInRateDPS

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

      • getAllInMidRate

        @Nullable
public @Nullable java.math.BigDecimal getAllInMidRate()
        Returns:
        The mid rate used in charging customers for accepting banker's acceptances, consisting of the discount interest rate plus the commission.

      • getFwdPoints

        @Nullable
public @Nullable java.math.BigDecimal getFwdPoints()
        Returns:
        fwdPoints e.g. 0.001198

      • getFwdMidPoints

        @Nullable
public @Nullable java.math.BigDecimal getFwdMidPoints()
        Returns:
        The number of basis points added to or subtracted from the mid rate to determine the forward rate for delivery on a specific value date.

      • getFwdPips

        @Deprecated
@Nullable
public @Nullable java.lang.String getFwdPips()
        Deprecated.
        Returns:
        fwdPips e.g. 11.98

      • getBuySell

        @Nullable
public @Nullable java.lang.String getBuySell()
        Returns:
        The direction of the trade or trade leg, from the client's perspective. This always refers to the BaseCurrency, NOT the DealtCurrency.

      • getAmount

        @Nullable
public @Nullable java.math.BigDecimal getAmount()
        Returns:
        The amount of a trade or order in the DealtCurrency.

      • getContraAmount

        @Nullable
public @Nullable java.math.BigDecimal getContraAmount()
        Returns:
        The amount that is exchanged for the Amount. This will be defined in the contra currency of the DealtCurrency.

      • getTenor

        @Nullable
public @Nullable java.lang.String getTenor()
        Returns:
        Supported types are [ON, [TODAY, TOD, TD], TN, [TOM, ND], SPOT, SN, 1D, 1W, 2W, 3W, 4W, 1M, 2M, 4M, 5M, 6M, 7M, 8M, 9M, 10M, 11M, [1Y, 12M], 15M, 18M, 21M, [2Y, 24M], [3Y, 36M], [4Y, 48M], [5Y, 60M], broken]. 'broken' indicates that the settlement date does not fall onto a tenor.

      • getSettlementDate

        @Nullable
public @Nullable java.lang.String getSettlementDate()
        Returns:
        settlementDate

      • getFilledAmount

        @Nullable
public @Nullable java.math.BigDecimal getFilledAmount()
        Returns:
        filledAmount e.g. 0

      • getRemainingAmount

        @Nullable
public @Nullable java.math.BigDecimal getRemainingAmount()
        Returns:
        remainingAmount e.g. 500

      • getRiskDate

        @Nullable
public @Nullable java.lang.String getRiskDate()
        Returns:
        The date in the settlement window which yields the lowest client sell price, or the highest client buy price.

      • getRiskTenor

        @Nullable
public @Nullable java.lang.String getRiskTenor()
        Returns:
        The tenor in the settlement window which yields the lowest client sell price, or the highest client buy price.

      • getStartDate

        @Nullable
public @Nullable java.lang.String getStartDate()
        Returns:
        startDate e.g. 20150620

      • getStartTenor

        @Nullable
public @Nullable java.lang.String getStartTenor()
        Returns:
        startTenor e.g. 1W

      • getIsTimeOption

        @Nullable
public @Nullable java.lang.Boolean getIsTimeOption()
        Returns:
        true if a leg is time-option

      • 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>

      • getProfit

        @Nullable
public @Nullable java.math.BigDecimal getProfit()
        Returns:
        The sales profit in the specified currency.

      • getCostAmount

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

      • 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.

      • 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.lang.String 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%.

      • getServiceContraCostAmount

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

      • getServiceContraCostCurrency

        @Nullable
public @Nullable java.lang.String getServiceContraCostCurrency()
        Returns:
        The service contra currency that the cost is displayed in

      • getServiceCostAmount

        @Nullable
public @Nullable java.math.BigDecimal getServiceCostAmount()
        Returns:
        The actual service cost of performing the trade to the client on the home currency

      • getServiceCostCurrency

        @Nullable
public @Nullable java.lang.String getServiceCostCurrency()
        Returns:
        The service home currency that the cost is displayed in

      • 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

      • getForwardPointsDecimalOffset

        @Nullable
public @Nullable java.lang.Integer getForwardPointsDecimalOffset()
        Returns:
        Optional override to determine the number of decimal places to move forward points before displaying them. Should be used if standard display of pips is not desired.

      • getAllocatableAmount

        @Nullable
public @Nullable java.math.BigDecimal getAllocatableAmount()
        Returns:
        This is the amount that can be allocated or rolled.

      • getAllocatableContraAmount

        @Nullable
public @Nullable java.math.BigDecimal getAllocatableContraAmount()
        Returns:
        This is the amount that can be allocated or rolled, defined in the contra currency of the DealtCurrency

      • getOriginalRate

        @Nullable
public @Nullable java.math.BigDecimal getOriginalRate()
        Returns:
        The Rate of the trade that this trade was created from.

      • getAdjustedSwapPoints

        @Nullable
public @Nullable java.math.BigDecimal getAdjustedSwapPoints()
        Returns:
        The swap points adjusted for this repriced trade

      • getNumRemarks

        @Nullable
public @org.jetbrains.annotations.Nullable int getNumRemarks()

      • 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

      • from

        @NotNull
public static @NotNull TradeConfPartsDef.LegTradeConfirmationFields from​(@NotNull
                                                                         @NotNull java.util.Map<java.lang.String,​java.lang.String> fields,
                                                                         @NotNull
                                                                         @NotNull java.lang.String fieldPrefix)