Package com.commercetools.api.models.cart

Class RecurringPaymentAllocationBuilder

java.lang.Object

com.commercetools.api.models.cart.RecurringPaymentAllocationBuilder

All Implemented Interfaces:

Builder<RecurringPaymentAllocation>

public class RecurringPaymentAllocationBuilder
extends Object
implements Builder<RecurringPaymentAllocation>

RecurringPaymentAllocationBuilder Example to create an instance using the builder pattern

     RecurringPaymentAllocation recurringPaymentAllocation = RecurringPaymentAllocation.builder()
             .id("{id}")
             .paymentMethod(paymentMethodBuilder -> paymentMethodBuilder)
             .allocation(allocationBuilder -> allocationBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
RecurringPaymentAllocationBuilder()

Method Summary

Modifier and Type	Method	Description
RecurringPaymentAllocationBuilder	allocation(Allocation allocation)	Share of the Order total charged to the paymentMethod.
RecurringPaymentAllocationBuilder	allocation(Function<AllocationBuilder,Builder<? extends Allocation>> builder)	Share of the Order total charged to the paymentMethod.
RecurringPaymentAllocation	build()	builds RecurringPaymentAllocation with checking for non-null required values
RecurringPaymentAllocation	buildUnchecked()	builds RecurringPaymentAllocation without checking for non-null required values
Allocation	getAllocation()	Share of the Order total charged to the paymentMethod.
String	getId()	Unique identifier of the RecurringPaymentAllocation within the RecurringPaymentConfiguration.
PaymentMethodReference	getPaymentMethod()	Payment Method charged for this share of the Order total.
RecurringPaymentAllocationBuilder	id(String id)	Unique identifier of the RecurringPaymentAllocation within the RecurringPaymentConfiguration.
static RecurringPaymentAllocationBuilder	of()	factory method for an instance of RecurringPaymentAllocationBuilder
static RecurringPaymentAllocationBuilder	of(RecurringPaymentAllocation template)	create builder for RecurringPaymentAllocation instance
RecurringPaymentAllocationBuilder	paymentMethod(PaymentMethodReference paymentMethod)	Payment Method charged for this share of the Order total.
RecurringPaymentAllocationBuilder	paymentMethod(Function<PaymentMethodReferenceBuilder,PaymentMethodReferenceBuilder> builder)	Payment Method charged for this share of the Order total.
RecurringPaymentAllocationBuilder	withPaymentMethod(Function<PaymentMethodReferenceBuilder,PaymentMethodReference> builder)	Payment Method charged for this share of the Order total.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RecurringPaymentAllocationBuilder

public RecurringPaymentAllocationBuilder()

Method Details

id

public RecurringPaymentAllocationBuilder id(String id)

Unique identifier of the RecurringPaymentAllocation within the RecurringPaymentConfiguration. Use it to remove the allocation with the Remove RecurringPaymentAllocation update action.

Parameters:

id - value to be set

Returns:

Builder

paymentMethod

public RecurringPaymentAllocationBuilder paymentMethod(Function<PaymentMethodReferenceBuilder,PaymentMethodReferenceBuilder> builder)

Payment Method charged for this share of the Order total.

Parameters:

builder - function to build the paymentMethod value

Returns:

Builder

withPaymentMethod

public RecurringPaymentAllocationBuilder withPaymentMethod(Function<PaymentMethodReferenceBuilder,PaymentMethodReference> builder)

Payment Method charged for this share of the Order total.

Parameters:

builder - function to build the paymentMethod value

Returns:

Builder

paymentMethod

public RecurringPaymentAllocationBuilder paymentMethod(PaymentMethodReference paymentMethod)

Payment Method charged for this share of the Order total.

Parameters:

paymentMethod - value to be set

Returns:

Builder

allocation

public RecurringPaymentAllocationBuilder allocation(Allocation allocation)

Share of the Order total charged to the paymentMethod.

Parameters:

allocation - value to be set

Returns:

Builder

allocation

public RecurringPaymentAllocationBuilder allocation(Function<AllocationBuilder,Builder<? extends Allocation>> builder)

Share of the Order total charged to the paymentMethod.

Parameters:

builder - function to build the allocation value

Returns:

Builder

getId

public String getId()

Unique identifier of the RecurringPaymentAllocation within the RecurringPaymentConfiguration. Use it to remove the allocation with the Remove RecurringPaymentAllocation update action.

Returns:

id

getPaymentMethod

public PaymentMethodReference getPaymentMethod()

Payment Method charged for this share of the Order total.

Returns:

paymentMethod

getAllocation

public Allocation getAllocation()

Share of the Order total charged to the paymentMethod.

Returns:

allocation

build

public RecurringPaymentAllocation build()

builds RecurringPaymentAllocation with checking for non-null required values

Specified by:

build in interface Builder<RecurringPaymentAllocation>

Returns:

RecurringPaymentAllocation

buildUnchecked

public RecurringPaymentAllocation buildUnchecked()

builds RecurringPaymentAllocation without checking for non-null required values

Returns:

RecurringPaymentAllocation

of

public static RecurringPaymentAllocationBuilder of()

factory method for an instance of RecurringPaymentAllocationBuilder

Returns:

builder

of

public static RecurringPaymentAllocationBuilder of(RecurringPaymentAllocation template)

create builder for RecurringPaymentAllocation instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder