io.sphere.sdk.orders.messages

Class ParcelRemovedFromDeliveryMessage

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.models.ResourceViewImpl<T,T>

io.sphere.sdk.models.ResourceImpl<Message>

io.sphere.sdk.messages.GenericMessageImpl<Order>

io.sphere.sdk.orders.messages.ParcelRemovedFromDeliveryMessage

All Implemented Interfaces:

GenericMessage<Order>, Message, CreationTimestamped, Identifiable<Message>, Referenceable<Message>, Resource<Message>, ResourceIdentifiable<Message>, ResourceView<Message,Message>, Timestamped, Versioned<Message>, OrderMessage, SimpleOrderMessage

public final class ParcelRemovedFromDeliveryMessage
extends GenericMessageImpl<Order>
implements SimpleOrderMessage

This message is the result of the RemoveParcelFromDelivery update action.

withOrder(client(), order -> {
    final List<ParcelDraft> parcels = asList(ParcelDraft.of(SMALL_PARCEL_MEASUREMENTS, TRACKING_DATA));
    final LineItem lineItem = order.getLineItems().get(0);
    final long availableItemsToShip = 1;
    final List<DeliveryItem> initialItems = asList(DeliveryItem.of(lineItem, availableItemsToShip));
    final Order orderWithDelivery = client().executeBlocking(OrderUpdateCommand.of(order, AddDelivery.of(initialItems, parcels)));

    assertThat(orderWithDelivery.getShippingInfo().getDeliveries()).hasSize(1);
    final Delivery delivery = orderWithDelivery.getShippingInfo().getDeliveries().get(0);
    assertThat(delivery.getParcels()).hasSize(1);
    final Parcel parcel = delivery.getParcels().get(0);

    final Order orderWithoutParcel = client().executeBlocking(OrderUpdateCommand.of(orderWithDelivery, RemoveParcelFromDelivery.of(parcel.getId())));
    assertThat(orderWithoutParcel.getShippingInfo().getDeliveries()).hasSize(1);
    final Delivery deliveryWithoutParcel = orderWithoutParcel.getShippingInfo().getDeliveries().get(0);
    assertThat(deliveryWithoutParcel.getParcels()).isEmpty();

    //you can observe a message
    final Query<ParcelRemovedFromDeliveryMessage> messageQuery = MessageQuery.of()
            .withPredicates(m -> m.resource().is(order))
            .forMessageType(ParcelRemovedFromDeliveryMessage.MESSAGE_HINT);
    assertEventually(() -> {
        final Optional<ParcelRemovedFromDeliveryMessage> parcelRemovedFromDeliveryMessageOptional =
                client().executeBlocking(messageQuery).head();
        assertThat(parcelRemovedFromDeliveryMessageOptional).isPresent();
        final ParcelRemovedFromDeliveryMessage parcelRemovedFromDeliveryMessage = parcelRemovedFromDeliveryMessageOptional.get();
        assertThat(parcelRemovedFromDeliveryMessage.getDeliveryId()).isEqualTo(delivery.getId());
        assertThat(parcelRemovedFromDeliveryMessage.getParcel()).isEqualTo(parcel);
    });
});
See the test code.

Field Summary

Fields

Modifier and Type	Field and Description
static MessageDerivateHint<ParcelRemovedFromDeliveryMessage>	MESSAGE_HINT
static String	MESSAGE_TYPE

Fields inherited from class io.sphere.sdk.messages.GenericMessageImpl

resource, resourceUserProvidedIdentifiers, resourceVersion, sequenceNumber, type

Method Summary

Modifier and Type	Method and Description
String	getDeliveryId()
Parcel	getParcel()

Methods inherited from class io.sphere.sdk.messages.GenericMessageImpl

as, equals, getPayload, getResource, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, hashCode, toReference

Methods inherited from class io.sphere.sdk.models.ResourceViewImpl

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from class io.sphere.sdk.models.Base

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.messages.GenericMessage

getResource

Methods inherited from interface io.sphere.sdk.messages.Message

as, getPayload, getResourceUserProvidedIdentifiers, getResourceVersion, getSequenceNumber, getType, referenceOfId, referenceTypeId, toReference, typeReference

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Methods inherited from interface io.sphere.sdk.orders.messages.OrderMessage

getType

Field Detail

MESSAGE_TYPE

public static final String MESSAGE_TYPE

See Also:

Constant Field Values

MESSAGE_HINT

public static final MessageDerivateHint<ParcelRemovedFromDeliveryMessage> MESSAGE_HINT

Method Detail

getDeliveryId

public String getDeliveryId()

getParcel

public Parcel getParcel()