Package com.commercetools.api.models.message

Interface OrderReturnShipmentStateChangedMessage

All Superinterfaces:

BaseResource, DomainResource<Message>, Identifiable<Message>, Message, OrderMessage, Versioned<Message>

public interface OrderReturnShipmentStateChangedMessage
extends OrderMessage

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

Example to create an instance using the builder pattern

     OrderReturnShipmentStateChangedMessage orderReturnShipmentStateChangedMessage = OrderReturnShipmentStateChangedMessage.builder()
             .id("{id}")
             .version(0.3)
             .createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .sequenceNumber(0.3)
             .resource(resourceBuilder -> resourceBuilder)
             .resourceVersion(0.3)
             .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 OrderReturnShipmentStateChangedMessage

Method Summary

Modifier and Type	Method	Description
static OrderReturnShipmentStateChangedMessageBuilder	builder()	builder factory method for OrderReturnShipmentStateChangedMessage
static OrderReturnShipmentStateChangedMessageBuilder	builder(OrderReturnShipmentStateChangedMessage template)	create builder for OrderReturnShipmentStateChangedMessage instance
static OrderReturnShipmentStateChangedMessage	deepCopy(OrderReturnShipmentStateChangedMessage template)	factory method to create a deep copy of OrderReturnShipmentStateChangedMessage
@NotNull String	getReturnItemId()	Unique identifier of the ReturnItem.
@NotNull ReturnShipmentState	getReturnShipmentState()	State of the ReturnItem after the Set Return Shipment State update action.
static OrderReturnShipmentStateChangedMessage	of()	factory method
static OrderReturnShipmentStateChangedMessage	of(OrderReturnShipmentStateChangedMessage template)	factory method to create a shallow copy OrderReturnShipmentStateChangedMessage
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<OrderReturnShipmentStateChangedMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderReturnShipmentStateChangedMessage(Function<OrderReturnShipmentStateChangedMessage,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

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

getCreatedAt, getCreatedBy, getId, getLastModifiedAt, getLastModifiedBy, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, getVersion, setCreatedAt, setCreatedBy, setId, setLastModifiedAt, setLastModifiedBy, setResource, setResourceUserProvidedIdentifiers, setResourceVersion, setSequenceNumber, setVersion, withMessage

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

withOrderMessage

Field Details

ORDER_RETURN_SHIPMENT_STATE_CHANGED

static final String ORDER_RETURN_SHIPMENT_STATE_CHANGED

discriminator value for OrderReturnShipmentStateChangedMessage

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

factory method

Returns:

instance of OrderReturnShipmentStateChangedMessage

of

static OrderReturnShipmentStateChangedMessage of(OrderReturnShipmentStateChangedMessage template)

factory method to create a shallow copy OrderReturnShipmentStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderReturnShipmentStateChangedMessage deepCopy(@Nullable
 OrderReturnShipmentStateChangedMessage template)

factory method to create a deep copy of OrderReturnShipmentStateChangedMessage

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderReturnShipmentStateChangedMessageBuilder builder()

builder factory method for OrderReturnShipmentStateChangedMessage

Returns:

builder

builder

static OrderReturnShipmentStateChangedMessageBuilder builder(OrderReturnShipmentStateChangedMessage template)

create builder for OrderReturnShipmentStateChangedMessage instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderReturnShipmentStateChangedMessage

default <T> T withOrderReturnShipmentStateChangedMessage(Function<OrderReturnShipmentStateChangedMessage,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<OrderReturnShipmentStateChangedMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference