Package com.commercetools.api.models.message

Interface OrderReturnShipmentStateChangedMessagePayload

All Superinterfaces:

MessagePayload, MessagePayloadMixin, OrderMessagePayload

public interface OrderReturnShipmentStateChangedMessagePayload
extends OrderMessagePayload

Generated after a successful Set ReturnShipmentState update action on Orders and Order Edits.

Example to create an instance using the builder pattern

     OrderReturnShipmentStateChangedMessagePayload orderReturnShipmentStateChangedMessagePayload = OrderReturnShipmentStateChangedMessagePayload.builder()
             .returnItemId("{returnItemId}")
             .returnShipmentState(ReturnShipmentState.ADVISED)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ORDER_RETURN_SHIPMENT_STATE_CHANGED	discriminator value for OrderReturnShipmentStateChangedMessagePayload

Method Summary

Modifier and Type	Method	Description
static OrderReturnShipmentStateChangedMessagePayloadBuilder	builder()	builder factory method for OrderReturnShipmentStateChangedMessagePayload
static OrderReturnShipmentStateChangedMessagePayloadBuilder	builder(OrderReturnShipmentStateChangedMessagePayload template)	create builder for OrderReturnShipmentStateChangedMessagePayload instance
static OrderReturnShipmentStateChangedMessagePayload	deepCopy(OrderReturnShipmentStateChangedMessagePayload template)	factory method to create a deep copy of OrderReturnShipmentStateChangedMessagePayload
@NotNull String	getReturnItemId()	Unique identifier of the ReturnItem.
@NotNull ReturnShipmentState	getReturnShipmentState()	State of the ReturnItem after the Set Return Shipment State update action.
static OrderReturnShipmentStateChangedMessagePayload	of()	factory method
static OrderReturnShipmentStateChangedMessagePayload	of(OrderReturnShipmentStateChangedMessagePayload template)	factory method to create a shallow copy OrderReturnShipmentStateChangedMessagePayload
void	setReturnItemId(String returnItemId)	Unique identifier of the ReturnItem.
void	setReturnShipmentState(ReturnShipmentState returnShipmentState)	State of the ReturnItem after the Set Return Shipment State update action.
static com.fasterxml.jackson.core.type.TypeReference<OrderReturnShipmentStateChangedMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderReturnShipmentStateChangedMessagePayload(Function<OrderReturnShipmentStateChangedMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.MessagePayloadMixin

as

Methods inherited from interface com.commercetools.api.models.message.OrderMessagePayload

withOrderMessagePayload

Field Details

ORDER_RETURN_SHIPMENT_STATE_CHANGED

static final String ORDER_RETURN_SHIPMENT_STATE_CHANGED

discriminator value for OrderReturnShipmentStateChangedMessagePayload

See Also:

• Constant Field Values

Method Details

getReturnItemId

@NotNull
@NotNull String getReturnItemId()

Unique identifier of the ReturnItem.

Returns:

returnItemId

getReturnShipmentState

@NotNull
@NotNull ReturnShipmentState getReturnShipmentState()

State of the ReturnItem after the Set Return Shipment State update action.

Returns:

returnShipmentState

setReturnItemId

void setReturnItemId(String returnItemId)

Unique identifier of the ReturnItem.

Parameters:

returnItemId - value to be set

setReturnShipmentState

void setReturnShipmentState(ReturnShipmentState returnShipmentState)

State of the ReturnItem after the Set Return Shipment State update action.

Parameters:

returnShipmentState - value to be set

of

static OrderReturnShipmentStateChangedMessagePayload of()

factory method

Returns:

instance of OrderReturnShipmentStateChangedMessagePayload

of

static OrderReturnShipmentStateChangedMessagePayload of(OrderReturnShipmentStateChangedMessagePayload template)

factory method to create a shallow copy OrderReturnShipmentStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderReturnShipmentStateChangedMessagePayload deepCopy(@Nullable
 OrderReturnShipmentStateChangedMessagePayload template)

factory method to create a deep copy of OrderReturnShipmentStateChangedMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderReturnShipmentStateChangedMessagePayloadBuilder builder()

builder factory method for OrderReturnShipmentStateChangedMessagePayload

Returns:

builder

builder

static OrderReturnShipmentStateChangedMessagePayloadBuilder builder(OrderReturnShipmentStateChangedMessagePayload template)

create builder for OrderReturnShipmentStateChangedMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderReturnShipmentStateChangedMessagePayload

default <T> T withOrderReturnShipmentStateChangedMessagePayload(Function<OrderReturnShipmentStateChangedMessagePayload,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<OrderReturnShipmentStateChangedMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference