Package com.commercetools.api.models.order

Interface OrderSetReturnPaymentStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderSetReturnPaymentStateAction
extends OrderUpdateAction

To set a ReturnPaymentState, the Order returnInfo must have at least one ReturnItem.

Example to create an instance using the builder pattern

     OrderSetReturnPaymentStateAction orderSetReturnPaymentStateAction = OrderSetReturnPaymentStateAction.builder()
             .paymentState(ReturnPaymentState.NON_REFUNDABLE)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_RETURN_PAYMENT_STATE	discriminator value for OrderSetReturnPaymentStateAction

Method Summary

Modifier and Type	Method	Description
static OrderSetReturnPaymentStateActionBuilder	builder()	builder factory method for OrderSetReturnPaymentStateAction
static OrderSetReturnPaymentStateActionBuilder	builder(OrderSetReturnPaymentStateAction template)	create builder for OrderSetReturnPaymentStateAction instance
OrderSetReturnPaymentStateAction	copyDeep()
static OrderSetReturnPaymentStateAction	deepCopy(OrderSetReturnPaymentStateAction template)	factory method to create a deep copy of OrderSetReturnPaymentStateAction
@NotNull ReturnPaymentState	getPaymentState()	New Payment status of the ReturnItem.
String	getReturnItemId()	id of the ReturnItem to update.
String	getReturnItemKey()	key of the ReturnItem to update.
static OrderSetReturnPaymentStateAction	of()	factory method
static OrderSetReturnPaymentStateAction	of(OrderSetReturnPaymentStateAction template)	factory method to create a shallow copy OrderSetReturnPaymentStateAction
void	setPaymentState(ReturnPaymentState paymentState)	New Payment status of the ReturnItem.
void	setReturnItemId(String returnItemId)	id of the ReturnItem to update.
void	setReturnItemKey(String returnItemKey)	key of the ReturnItem to update.
static com.fasterxml.jackson.core.type.TypeReference<OrderSetReturnPaymentStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetReturnPaymentStateAction(Function<OrderSetReturnPaymentStateAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.order.OrderUpdateAction

getAction, withOrderUpdateAction

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

get

Field Details

SET_RETURN_PAYMENT_STATE

static final String SET_RETURN_PAYMENT_STATE

discriminator value for OrderSetReturnPaymentStateAction

See Also:

• Constant Field Values

Method Details

getReturnItemId

String getReturnItemId()

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Returns:

returnItemId

getReturnItemKey

String getReturnItemKey()

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Returns:

returnItemKey

getPaymentState

@NotNull
@NotNull ReturnPaymentState getPaymentState()

New Payment status of the ReturnItem.

Returns:

paymentState

setReturnItemId

void setReturnItemId(String returnItemId)

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Parameters:

returnItemId - value to be set

setReturnItemKey

void setReturnItemKey(String returnItemKey)

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Parameters:

returnItemKey - value to be set

setPaymentState

void setPaymentState(ReturnPaymentState paymentState)

New Payment status of the ReturnItem.

Parameters:

paymentState - value to be set

of

static OrderSetReturnPaymentStateAction of()

factory method

Returns:

instance of OrderSetReturnPaymentStateAction

of

static OrderSetReturnPaymentStateAction of(OrderSetReturnPaymentStateAction template)

factory method to create a shallow copy OrderSetReturnPaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderSetReturnPaymentStateAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderSetReturnPaymentStateAction deepCopy(@Nullable
 OrderSetReturnPaymentStateAction template)

factory method to create a deep copy of OrderSetReturnPaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetReturnPaymentStateActionBuilder builder()

builder factory method for OrderSetReturnPaymentStateAction

Returns:

builder

builder

static OrderSetReturnPaymentStateActionBuilder builder(OrderSetReturnPaymentStateAction template)

create builder for OrderSetReturnPaymentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetReturnPaymentStateAction

default <T> T withOrderSetReturnPaymentStateAction(Function<OrderSetReturnPaymentStateAction,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<OrderSetReturnPaymentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference