Package com.commercetools.api.models.payment

Interface PaymentUpdate

All Superinterfaces:

ResourceUpdate<PaymentUpdate,PaymentUpdateAction,PaymentUpdateBuilder>

All Known Implementing Classes:

PaymentUpdateImpl

public interface PaymentUpdate
extends ResourceUpdate<PaymentUpdate,PaymentUpdateAction,PaymentUpdateBuilder>

PaymentUpdate Example to create an instance using the builder pattern

     PaymentUpdate paymentUpdate = PaymentUpdate.builder()
             .version(0.3)
             .plusActions(actionsBuilder -> actionsBuilder)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static PaymentUpdateBuilder	builder()	builder factory method for PaymentUpdate
static PaymentUpdateBuilder	builder(PaymentUpdate template)	create builder for PaymentUpdate instance
static PaymentUpdate	deepCopy(PaymentUpdate template)	factory method to create a deep copy of PaymentUpdate
@NotNull @Valid List<PaymentUpdateAction>	getActions()	Update actions to be performed on the Payment.
@NotNull Long	getVersion()	Expected version of the Payment on which the changes should be applied.
static PaymentUpdate	of()	factory method
static PaymentUpdate	of(PaymentUpdate template)	factory method to create a shallow copy PaymentUpdate
void	setActions(PaymentUpdateAction... actions)	Update actions to be performed on the Payment.
void	setActions(List<PaymentUpdateAction> actions)	Update actions to be performed on the Payment.
void	setVersion(Long version)	Expected version of the Payment on which the changes should be applied.
static com.fasterxml.jackson.core.type.TypeReference<PaymentUpdate>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentUpdate(Function<PaymentUpdate,T> helper)	accessor map function

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

get

Method Details

getVersion

@NotNull
@NotNull Long getVersion()

Expected version of the Payment on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

getVersion in interface ResourceUpdate<PaymentUpdate,PaymentUpdateAction,PaymentUpdateBuilder>

Returns:

version

getActions

@NotNull
@Valid
@NotNull @Valid List<PaymentUpdateAction> getActions()

Update actions to be performed on the Payment.

Specified by:

getActions in interface ResourceUpdate<PaymentUpdate,PaymentUpdateAction,PaymentUpdateBuilder>

Returns:

actions

setVersion

void setVersion(Long version)

Expected version of the Payment on which the changes should be applied. If the expected version does not match the actual version, a ConcurrentModification error will be returned.

Specified by:

setVersion in interface ResourceUpdate<PaymentUpdate,PaymentUpdateAction,PaymentUpdateBuilder>

Parameters:

version - value to be set

setActions

void setActions(PaymentUpdateAction... actions)

Update actions to be performed on the Payment.

Parameters:

actions - values to be set

setActions

void setActions(List<PaymentUpdateAction> actions)

Update actions to be performed on the Payment.

Specified by:

setActions in interface ResourceUpdate<PaymentUpdate,PaymentUpdateAction,PaymentUpdateBuilder>

Parameters:

actions - values to be set

of

static PaymentUpdate of()

factory method

Returns:

instance of PaymentUpdate

of

static PaymentUpdate of(PaymentUpdate template)

factory method to create a shallow copy PaymentUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static PaymentUpdate deepCopy(@Nullable
 PaymentUpdate template)

factory method to create a deep copy of PaymentUpdate

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentUpdateBuilder builder()

builder factory method for PaymentUpdate

Returns:

builder

builder

static PaymentUpdateBuilder builder(PaymentUpdate template)

create builder for PaymentUpdate instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentUpdate

default <T> T withPaymentUpdate(Function<PaymentUpdate,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<PaymentUpdate> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference