Package com.commercetools.history.models.label

Interface PaymentLabel

All Superinterfaces:
Label
public interface PaymentLabel extends Label
PaymentLabel
Example to create an instance using the builder pattern 

     PaymentLabel paymentLabel = PaymentLabel.builder()
             .key("{key}")
             .amountPlanned(amountPlannedBuilder -> amountPlannedBuilder)
             .build()

  • Field Details

  • Method Details

    • getType

      @NotNull @NotNull String getType()
      Specified by:
      getType in interface Label
      Returns:
      type

    • getKey

      @NotNull @NotNull String getKey()

      User-defined unique identifier of the Payment.

      Returns:
      key

    • getAmountPlanned

      @NotNull @Valid @NotNull @Valid Money getAmountPlanned()

      Money value the Payment intends to receive from the Customer.

      Returns:
      amountPlanned

    • setKey

      void setKey(String key)

      User-defined unique identifier of the Payment.

      Parameters:
      key - value to be set

    • setAmountPlanned

      void setAmountPlanned(Money amountPlanned)

      Money value the Payment intends to receive from the Customer.

      Parameters:
      amountPlanned - value to be set

    • of

      static PaymentLabel of()
      factory method
      Returns:
      instance of PaymentLabel

    • of

      static PaymentLabel of(PaymentLabel template)
      factory method to create a shallow copy PaymentLabel
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      PaymentLabel copyDeep()
      Specified by:
      copyDeep in interface Label

    • deepCopy

      @Nullable static PaymentLabel deepCopy(@Nullable PaymentLabel template)
      factory method to create a deep copy of PaymentLabel
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static PaymentLabelBuilder builder()
      builder factory method for PaymentLabel
      Returns:
      builder

    • builder

      static PaymentLabelBuilder builder(PaymentLabel template)
      create builder for PaymentLabel instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withPaymentLabel

      default <T> T withPaymentLabel(Function<PaymentLabel,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<PaymentLabel> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference