Package com.commercetools.api.models.payment

Interface PaymentChangeAmountPlannedAction

All Superinterfaces:

PaymentUpdateAction, ResourceUpdateAction<PaymentUpdateAction>

public interface PaymentChangeAmountPlannedAction
extends PaymentUpdateAction

Can be used to update the Payment if a customer changes the Cart, or adds or removes a CartDiscount during checkout.

Example to create an instance using the builder pattern

     PaymentChangeAmountPlannedAction paymentChangeAmountPlannedAction = PaymentChangeAmountPlannedAction.builder()
             .amount(amountBuilder -> amountBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_AMOUNT_PLANNED	discriminator value for PaymentChangeAmountPlannedAction

Method Summary

Modifier and Type	Method	Description
static PaymentChangeAmountPlannedActionBuilder	builder()	builder factory method for PaymentChangeAmountPlannedAction
static PaymentChangeAmountPlannedActionBuilder	builder(PaymentChangeAmountPlannedAction template)	create builder for PaymentChangeAmountPlannedAction instance
PaymentChangeAmountPlannedAction	copyDeep()
static PaymentChangeAmountPlannedAction	deepCopy(PaymentChangeAmountPlannedAction template)	factory method to create a deep copy of PaymentChangeAmountPlannedAction
@NotNull @Valid Money	getAmount()	New value to set.
static PaymentChangeAmountPlannedAction	of()	factory method
static PaymentChangeAmountPlannedAction	of(PaymentChangeAmountPlannedAction template)	factory method to create a shallow copy PaymentChangeAmountPlannedAction
void	setAmount(Money amount)	New value to set.
static com.fasterxml.jackson.core.type.TypeReference<PaymentChangeAmountPlannedAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentChangeAmountPlannedAction(Function<PaymentChangeAmountPlannedAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.payment.PaymentUpdateAction

getAction, withPaymentUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

CHANGE_AMOUNT_PLANNED

static final String CHANGE_AMOUNT_PLANNED

discriminator value for PaymentChangeAmountPlannedAction

See Also:

• Constant Field Values

Method Details

getAmount

@NotNull
@Valid
@NotNull @Valid Money getAmount()

New value to set.

Returns:

amount

setAmount

void setAmount(Money amount)

New value to set.

Parameters:

amount - value to be set

of

static PaymentChangeAmountPlannedAction of()

factory method

Returns:

instance of PaymentChangeAmountPlannedAction

of

static PaymentChangeAmountPlannedAction of(PaymentChangeAmountPlannedAction template)

factory method to create a shallow copy PaymentChangeAmountPlannedAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentChangeAmountPlannedAction copyDeep()

Specified by:

copyDeep in interface PaymentUpdateAction

deepCopy

@Nullable
static PaymentChangeAmountPlannedAction deepCopy(@Nullable
 PaymentChangeAmountPlannedAction template)

factory method to create a deep copy of PaymentChangeAmountPlannedAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentChangeAmountPlannedActionBuilder builder()

builder factory method for PaymentChangeAmountPlannedAction

Returns:

builder

builder

static PaymentChangeAmountPlannedActionBuilder builder(PaymentChangeAmountPlannedAction template)

create builder for PaymentChangeAmountPlannedAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentChangeAmountPlannedAction

default <T> T withPaymentChangeAmountPlannedAction(Function<PaymentChangeAmountPlannedAction,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<PaymentChangeAmountPlannedAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference