Package com.commercetools.api.models.order_edit

Interface StagedOrderSetReturnShipmentStateAction

All Superinterfaces:

ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction

public interface StagedOrderSetReturnShipmentStateAction
extends StagedOrderUpdateAction

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

     StagedOrderSetReturnShipmentStateAction stagedOrderSetReturnShipmentStateAction = StagedOrderSetReturnShipmentStateAction.builder()
             .shipmentState(ReturnShipmentState.ADVISED)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static StagedOrderSetReturnShipmentStateActionBuilder	builder()	builder factory method for StagedOrderSetReturnShipmentStateAction
static StagedOrderSetReturnShipmentStateActionBuilder	builder(StagedOrderSetReturnShipmentStateAction template)	create builder for StagedOrderSetReturnShipmentStateAction instance
StagedOrderSetReturnShipmentStateAction	copyDeep()
static StagedOrderSetReturnShipmentStateAction	deepCopy(StagedOrderSetReturnShipmentStateAction template)	factory method to create a deep copy of StagedOrderSetReturnShipmentStateAction
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 StagedOrderSetReturnShipmentStateAction	of()	factory method
static StagedOrderSetReturnShipmentStateAction	of(StagedOrderSetReturnShipmentStateAction template)	factory method to create a shallow copy StagedOrderSetReturnShipmentStateAction
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<StagedOrderSetReturnShipmentStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStagedOrderSetReturnShipmentStateAction(Function<StagedOrderSetReturnShipmentStateAction,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_SHIPMENT_STATE

static final String SET_RETURN_SHIPMENT_STATE

discriminator value for StagedOrderSetReturnShipmentStateAction

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

factory method

Returns:

instance of StagedOrderSetReturnShipmentStateAction

of

static StagedOrderSetReturnShipmentStateAction of(StagedOrderSetReturnShipmentStateAction template)

factory method to create a shallow copy StagedOrderSetReturnShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StagedOrderSetReturnShipmentStateAction copyDeep()

Specified by:

copyDeep in interface StagedOrderUpdateAction

deepCopy

@Nullable
static StagedOrderSetReturnShipmentStateAction deepCopy(@Nullable
 StagedOrderSetReturnShipmentStateAction template)

factory method to create a deep copy of StagedOrderSetReturnShipmentStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StagedOrderSetReturnShipmentStateActionBuilder builder()

builder factory method for StagedOrderSetReturnShipmentStateAction

Returns:

builder

builder

static StagedOrderSetReturnShipmentStateActionBuilder builder(StagedOrderSetReturnShipmentStateAction template)

create builder for StagedOrderSetReturnShipmentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStagedOrderSetReturnShipmentStateAction

default <T> T withStagedOrderSetReturnShipmentStateAction(Function<StagedOrderSetReturnShipmentStateAction,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<StagedOrderSetReturnShipmentStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference