Class QuotePartsDef.AllocationLegFields.Builder

    • Method Detail

      • toString

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

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.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>
      • setEntityId

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.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 QuotePartsDef.AllocationLegFields.Builder setEntityDescription​(@NotNull
                                                                                       @NotNull java.lang.String entityDescription)
        Parameters:
        entityDescription - e.g. Customer 1
        Returns:
        The description of a trade on behalf of entity.
      • setTOBOUser

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.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.
      • setIsReprice

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.Builder setIsReprice​(@NotNull
                                                                               @NotNull java.lang.String isReprice)
        Returns:
        Defines if the leg of an allocation needs to be repriced.
      • setMarkToMarket

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.Builder setMarkToMarket​(@NotNull
                                                                                  @NotNull java.math.BigDecimal markToMarket)
        Parameters:
        markToMarket - e.g. 12.45
        Returns:
        A signed numerical value which represents a positive or negative cashflow when rolling forward or back a new deal from the original deal
      • setMarkToMarket

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.Builder setMarkToMarket​(@NotNull
                                                                                  @NotNull java.lang.String markToMarket)
        Parameters:
        markToMarket - e.g. 12.45
        Returns:
        A signed numerical value which represents a positive or negative cashflow when rolling forward or back a new deal from the original deal
      • setDisplayFields

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.Builder setDisplayFields​(@NotNull
                                                                                   @NotNull java.lang.String displayFields)
        Parameters:
        displayFields - e.g. method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAllocationDetailsUpdateFields','name':'addDefaultSalesAllocationDetailsUpdateFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}
        Returns:
        Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.
      • setDisplayFields

        @NotNull
        public @NotNull QuotePartsDef.AllocationLegFields.Builder setDisplayFields​(@NotNull
                                                                                   @NotNull DisplayFields displayFields)
        Parameters:
        displayFields - e.g. method={'import':'static com.caplin.motif.fx.config.DefaultDisplayFields.addDefaultSalesAllocationDetailsUpdateFields','name':'addDefaultSalesAllocationDetailsUpdateFields','comment':'See DefaultDisplayFields javadoc for parameters and available builder methods.'}
        Returns:
        Configuration for a frontend to display label-value pairs. Use DefaultDisplayFields builders to provide Caplin default and/or custom fields.