Package com.commercetools.api.models.order_edit

Interface StagedOrderSetReturnPaymentStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetReturnPaymentStateAction
extends StagedOrderUpdateAction

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

Example to create an instance using the builder pattern

     StagedOrderSetReturnPaymentStateAction stagedOrderSetReturnPaymentStateAction = StagedOrderSetReturnPaymentStateAction.builder()
             .paymentState(ReturnPaymentState.NON_REFUNDABLE)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetReturnPaymentStateActionBuilder	builder()	builder factory method for StagedOrderSetReturnPaymentStateAction
static StagedOrderSetReturnPaymentStateActionBuilder	builder(StagedOrderSetReturnPaymentStateAction template)	create builder for StagedOrderSetReturnPaymentStateAction instance
StagedOrderSetReturnPaymentStateAction	copyDeep()
static StagedOrderSetReturnPaymentStateAction	deepCopy(StagedOrderSetReturnPaymentStateAction template)	factory method to create a deep copy of StagedOrderSetReturnPaymentStateAction
@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 StagedOrderSetReturnPaymentStateAction	of()	factory method
static StagedOrderSetReturnPaymentStateAction	of(StagedOrderSetReturnPaymentStateAction template)	factory method to create a shallow copy StagedOrderSetReturnPaymentStateAction
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<StagedOrderSetReturnPaymentStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetReturnPaymentStateAction(Function<StagedOrderSetReturnPaymentStateAction,T> helper)	accessor map function

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

get

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

getAction, withStagedOrderUpdateAction

Field Details

SET_RETURN_PAYMENT_STATE

static final String SET_RETURN_PAYMENT_STATE

discriminator value for StagedOrderSetReturnPaymentStateAction

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 StagedOrderSetReturnPaymentStateAction of()

factory method

Returns:

instance of StagedOrderSetReturnPaymentStateAction

of

static StagedOrderSetReturnPaymentStateAction of(StagedOrderSetReturnPaymentStateAction template)

factory method to create a shallow copy StagedOrderSetReturnPaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetReturnPaymentStateAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetReturnPaymentStateAction deepCopy(@Nullable
 StagedOrderSetReturnPaymentStateAction template)

factory method to create a deep copy of StagedOrderSetReturnPaymentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetReturnPaymentStateActionBuilder builder()

builder factory method for StagedOrderSetReturnPaymentStateAction

Returns:

builder

builder

static StagedOrderSetReturnPaymentStateActionBuilder builder(StagedOrderSetReturnPaymentStateAction template)

create builder for StagedOrderSetReturnPaymentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetReturnPaymentStateAction

default <T> T withStagedOrderSetReturnPaymentStateAction(Function<StagedOrderSetReturnPaymentStateAction,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<StagedOrderSetReturnPaymentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference