Package com.commercetools.api.models.order

Interface OrderSetReturnShipmentStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderSetReturnShipmentStateAction
extends OrderUpdateAction

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

Produces the Order Return Shipment State Changed Message.

Example to create an instance using the builder pattern

     OrderSetReturnShipmentStateAction orderSetReturnShipmentStateAction = OrderSetReturnShipmentStateAction.builder()
             .shipmentState(ReturnShipmentState.ADVISED)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_RETURN_SHIPMENT_STATE	discriminator value for OrderSetReturnShipmentStateAction

Method Summary

Modifier and Type	Method	Description
static OrderSetReturnShipmentStateActionBuilder	builder()	builder factory method for OrderSetReturnShipmentStateAction
static OrderSetReturnShipmentStateActionBuilder	builder(OrderSetReturnShipmentStateAction template)	create builder for OrderSetReturnShipmentStateAction instance
OrderSetReturnShipmentStateAction	copyDeep()
static OrderSetReturnShipmentStateAction	deepCopy(OrderSetReturnShipmentStateAction template)	factory method to create a deep copy of OrderSetReturnShipmentStateAction
String	getReturnItemId()	id of the ReturnItem to update.
String	getReturnItemKey()	key of the ReturnItem to update.
@NotNull ReturnShipmentState	getShipmentState()	New shipment state of the ReturnItem.
static OrderSetReturnShipmentStateAction	of()	factory method
static OrderSetReturnShipmentStateAction	of(OrderSetReturnShipmentStateAction template)	factory method to create a shallow copy OrderSetReturnShipmentStateAction
void	setReturnItemId(String returnItemId)	id of the ReturnItem to update.
void	setReturnItemKey(String returnItemKey)	key of the ReturnItem to update.
void	setShipmentState(ReturnShipmentState shipmentState)	New shipment state of the ReturnItem.
static com.fasterxml.jackson.core.type.TypeReference<OrderSetReturnShipmentStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetReturnShipmentStateAction(Function<OrderSetReturnShipmentStateAction,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_SHIPMENT_STATE

static final String SET_RETURN_SHIPMENT_STATE

discriminator value for OrderSetReturnShipmentStateAction

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

getShipmentState

@NotNull
@NotNull ReturnShipmentState getShipmentState()

New shipment state of the ReturnItem.

Returns:

shipmentState

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

setShipmentState

void setShipmentState(ReturnShipmentState shipmentState)

New shipment state of the ReturnItem.

Parameters:

shipmentState - value to be set

of

static OrderSetReturnShipmentStateAction of()

factory method

Returns:

instance of OrderSetReturnShipmentStateAction

of

static OrderSetReturnShipmentStateAction of(OrderSetReturnShipmentStateAction template)

factory method to create a shallow copy OrderSetReturnShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderSetReturnShipmentStateAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderSetReturnShipmentStateAction deepCopy(@Nullable
 OrderSetReturnShipmentStateAction template)

factory method to create a deep copy of OrderSetReturnShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetReturnShipmentStateActionBuilder builder()

builder factory method for OrderSetReturnShipmentStateAction

Returns:

builder

builder

static OrderSetReturnShipmentStateActionBuilder builder(OrderSetReturnShipmentStateAction template)

create builder for OrderSetReturnShipmentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetReturnShipmentStateAction

default <T> T withOrderSetReturnShipmentStateAction(Function<OrderSetReturnShipmentStateAction,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<OrderSetReturnShipmentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference