Package com.commercetools.api.models.message

Interface OrderMessage

All Superinterfaces:

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

All Known Subinterfaces:

CustomLineItemStateTransitionMessage, DeliveryAddedMessage, DeliveryAddressSetMessage, DeliveryItemsUpdatedMessage, DeliveryRemovedMessage, LineItemStateTransitionMessage, OrderBillingAddressSetMessage, OrderCreatedMessage, OrderCustomerEmailSetMessage, OrderCustomerGroupSetMessage, OrderCustomerSetMessage, OrderCustomLineItemAddedMessage, OrderCustomLineItemDiscountSetMessage, OrderCustomLineItemQuantityChangedMessage, OrderCustomLineItemRemovedMessage, OrderDeletedMessage, OrderDiscountCodeAddedMessage, OrderDiscountCodeRemovedMessage, OrderDiscountCodeStateSetMessage, OrderEditAppliedMessage, OrderImportedMessage, OrderLineItemAddedMessage, OrderLineItemDiscountSetMessage, OrderLineItemDistributionChannelSetMessage, OrderLineItemRemovedMessage, OrderPaymentStateChangedMessage, OrderPurchaseOrderNumberSetMessage, OrderReturnShipmentStateChangedMessage, OrderShipmentStateChangedMessage, OrderShippingAddressSetMessage, OrderShippingInfoSetMessage, OrderShippingRateInputSetMessage, OrderStateChangedMessage, OrderStateTransitionMessage, OrderStoreSetMessage, ParcelAddedToDeliveryMessage, ParcelItemsUpdatedMessage, ParcelMeasurementsUpdatedMessage, ParcelRemovedFromDeliveryMessage, ParcelTrackingDataUpdatedMessage, ReturnInfoAddedMessage, ReturnInfoSetMessage

All Known Implementing Classes:

CustomLineItemStateTransitionMessageImpl, DeliveryAddedMessageImpl, DeliveryAddressSetMessageImpl, DeliveryItemsUpdatedMessageImpl, DeliveryRemovedMessageImpl, LineItemStateTransitionMessageImpl, OrderBillingAddressSetMessageImpl, OrderCreatedMessageImpl, OrderCustomerEmailSetMessageImpl, OrderCustomerGroupSetMessageImpl, OrderCustomerSetMessageImpl, OrderCustomLineItemAddedMessageImpl, OrderCustomLineItemDiscountSetMessageImpl, OrderCustomLineItemQuantityChangedMessageImpl, OrderCustomLineItemRemovedMessageImpl, OrderDeletedMessageImpl, OrderDiscountCodeAddedMessageImpl, OrderDiscountCodeRemovedMessageImpl, OrderDiscountCodeStateSetMessageImpl, OrderEditAppliedMessageImpl, OrderImportedMessageImpl, OrderLineItemAddedMessageImpl, OrderLineItemDiscountSetMessageImpl, OrderLineItemDistributionChannelSetMessageImpl, OrderLineItemRemovedMessageImpl, OrderMessageImpl, OrderPaymentStateChangedMessageImpl, OrderPurchaseOrderNumberSetMessageImpl, OrderReturnShipmentStateChangedMessageImpl, OrderShipmentStateChangedMessageImpl, OrderShippingAddressSetMessageImpl, OrderShippingInfoSetMessageImpl, OrderShippingRateInputSetMessageImpl, OrderStateChangedMessageImpl, OrderStateTransitionMessageImpl, OrderStoreSetMessageImpl, ParcelAddedToDeliveryMessageImpl, ParcelItemsUpdatedMessageImpl, ParcelMeasurementsUpdatedMessageImpl, ParcelRemovedFromDeliveryMessageImpl, ParcelTrackingDataUpdatedMessageImpl, ReturnInfoAddedMessageImpl, ReturnInfoSetMessageImpl

public interface OrderMessage
extends Message

OrderMessage Example to create an instance using the builder pattern

     OrderMessage orderMessage = OrderMessage.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)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static OrderMessage	deepCopy(OrderMessage template)	factory method to create a deep copy of OrderMessage
static com.fasterxml.jackson.core.type.TypeReference<OrderMessage>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderMessage(Function<OrderMessage,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

Method Details

deepCopy

@Nullable
static OrderMessage deepCopy(@Nullable
 OrderMessage template)

factory method to create a deep copy of OrderMessage

Parameters:

template - instance to be copied

Returns:

copy instance

withOrderMessage

default <T> T withOrderMessage(Function<OrderMessage,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<OrderMessage> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference