Package com.commercetools.api.models.cart

Interface RecurringPaymentConfigurationDraft

All Superinterfaces:
Draft<RecurringPaymentConfigurationDraft>
public interface RecurringPaymentConfigurationDraft extends Draft<RecurringPaymentConfigurationDraft>

Draft type that stores the data to create a RecurringPaymentConfiguration.

Example to create an instance using the builder pattern 

     RecurringPaymentConfigurationDraft recurringPaymentConfigurationDraft = RecurringPaymentConfigurationDraft.builder()
             .paymentStrategy(PaymentStrategy.CHECKOUT)
             .plusPaymentAllocations(paymentAllocationsBuilder -> paymentAllocationsBuilder)
             .build()

  • Method Details

    • getPaymentStrategy

      @NotNull @NotNull PaymentStrategy getPaymentStrategy()

      Determines how payment is collected for the Orders generated by the Recurring Order.

      Returns:
      paymentStrategy

    • getPaymentAllocations

      @NotNull @Valid @NotNull @Valid List<PaymentAllocationDraft> getPaymentAllocations()

      Payment Methods charged for the Orders generated by the Recurring Order, and the share of the Order total charged to each of them.

      Returns:
      paymentAllocations

    • setPaymentStrategy

      void setPaymentStrategy(PaymentStrategy paymentStrategy)

      Determines how payment is collected for the Orders generated by the Recurring Order.

      Parameters:
      paymentStrategy - value to be set

    • setPaymentAllocations

      void setPaymentAllocations(PaymentAllocationDraft... paymentAllocations)

      Payment Methods charged for the Orders generated by the Recurring Order, and the share of the Order total charged to each of them.

      Parameters:
      paymentAllocations - values to be set

    • setPaymentAllocations

      void setPaymentAllocations(List<PaymentAllocationDraft> paymentAllocations)

      Payment Methods charged for the Orders generated by the Recurring Order, and the share of the Order total charged to each of them.

      Parameters:
      paymentAllocations - values to be set

    • of

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

    • of

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

    • copyDeep

      RecurringPaymentConfigurationDraft copyDeep()

    • deepCopy

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

    • builder

      static RecurringPaymentConfigurationDraftBuilder builder()
      builder factory method for RecurringPaymentConfigurationDraft
      Returns:
      builder

    • builder

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

    • withRecurringPaymentConfigurationDraft

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

    • typeReference

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