Package com.commercetools.api.models.payment_method

Interface PaymentMethodSetPaymentMethodStatusAction

All Superinterfaces:

PaymentMethodUpdateAction

public interface PaymentMethodSetPaymentMethodStatusAction
extends PaymentMethodUpdateAction

This action generates the PaymentMethodPaymentMethodStatusSet Message.

A default Payment Method cannot be set as inactive, and the action will return an InvalidOperation error.

Example to create an instance using the builder pattern

     PaymentMethodSetPaymentMethodStatusAction paymentMethodSetPaymentMethodStatusAction = PaymentMethodSetPaymentMethodStatusAction.builder()
             .paymentMethodStatus(PaymentMethodStatus.ACTIVE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_PAYMENT_METHOD_STATUS	discriminator value for PaymentMethodSetPaymentMethodStatusAction

Method Summary

Modifier and Type	Method	Description
static PaymentMethodSetPaymentMethodStatusActionBuilder	builder()	builder factory method for PaymentMethodSetPaymentMethodStatusAction
static PaymentMethodSetPaymentMethodStatusActionBuilder	builder(PaymentMethodSetPaymentMethodStatusAction template)	create builder for PaymentMethodSetPaymentMethodStatusAction instance
PaymentMethodSetPaymentMethodStatusAction	copyDeep()
static PaymentMethodSetPaymentMethodStatusAction	deepCopy(PaymentMethodSetPaymentMethodStatusAction template)	factory method to create a deep copy of PaymentMethodSetPaymentMethodStatusAction
@NotNull PaymentMethodStatus	getPaymentMethodStatus()	Value to set.
static PaymentMethodSetPaymentMethodStatusAction	of()	factory method
static PaymentMethodSetPaymentMethodStatusAction	of(PaymentMethodSetPaymentMethodStatusAction template)	factory method to create a shallow copy PaymentMethodSetPaymentMethodStatusAction
void	setPaymentMethodStatus(PaymentMethodStatus paymentMethodStatus)	Value to set.
static com.fasterxml.jackson.core.type.TypeReference<PaymentMethodSetPaymentMethodStatusAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withPaymentMethodSetPaymentMethodStatusAction(Function<PaymentMethodSetPaymentMethodStatusAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.payment_method.PaymentMethodUpdateAction

getAction, withPaymentMethodUpdateAction

Field Details

SET_PAYMENT_METHOD_STATUS

static final String SET_PAYMENT_METHOD_STATUS

discriminator value for PaymentMethodSetPaymentMethodStatusAction

See Also:

• Constant Field Values

Method Details

getPaymentMethodStatus

@NotNull
@NotNull PaymentMethodStatus getPaymentMethodStatus()

Value to set.

Returns:

paymentMethodStatus

setPaymentMethodStatus

void setPaymentMethodStatus(PaymentMethodStatus paymentMethodStatus)

Value to set.

Parameters:

paymentMethodStatus - value to be set

of

static PaymentMethodSetPaymentMethodStatusAction of()

factory method

Returns:

instance of PaymentMethodSetPaymentMethodStatusAction

of

static PaymentMethodSetPaymentMethodStatusAction of(PaymentMethodSetPaymentMethodStatusAction template)

factory method to create a shallow copy PaymentMethodSetPaymentMethodStatusAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

PaymentMethodSetPaymentMethodStatusAction copyDeep()

Specified by:

copyDeep in interface PaymentMethodUpdateAction

deepCopy

@Nullable
static PaymentMethodSetPaymentMethodStatusAction deepCopy(@Nullable
 PaymentMethodSetPaymentMethodStatusAction template)

factory method to create a deep copy of PaymentMethodSetPaymentMethodStatusAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static PaymentMethodSetPaymentMethodStatusActionBuilder builder()

builder factory method for PaymentMethodSetPaymentMethodStatusAction

Returns:

builder

builder

static PaymentMethodSetPaymentMethodStatusActionBuilder builder(PaymentMethodSetPaymentMethodStatusAction template)

create builder for PaymentMethodSetPaymentMethodStatusAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withPaymentMethodSetPaymentMethodStatusAction

default <T> T withPaymentMethodSetPaymentMethodStatusAction(Function<PaymentMethodSetPaymentMethodStatusAction,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<PaymentMethodSetPaymentMethodStatusAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference