io.sphere.sdk.orders.commands.updateactions

Class TransitionLineItemState

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.UpdateActionImpl<Order>

io.sphere.sdk.orders.commands.updateactions.TransitionLineItemState

All Implemented Interfaces:

UpdateAction<Order>

public final class TransitionLineItemState
extends UpdateActionImpl<Order>

Change the state of a Line Item according to allowed transitions

See also OrderUpdateCommand.

withStandardStates(client(), (State initialState, State nextState) ->
    withOrder(client(), order -> {
        final LineItem lineItem = order.getLineItems().get(0);
        assertThat(lineItem).has(state(initialState)).has(not(state(nextState)));
        final long quantity = 1;
        final ZonedDateTime actualTransitionDate = ZonedDateTime_IN_PAST;
        final Order updatedOrder = client().executeBlocking(OrderUpdateCommand.of(order, TransitionLineItemState.of(lineItem, quantity, initialState, nextState, actualTransitionDate)));
        assertThat(updatedOrder.getLineItems().get(0)).has(itemStates(ItemState.of(nextState, quantity)));

        //you can observe a message
        final Query<LineItemStateTransitionMessage> messageQuery = MessageQuery.of()
                .withPredicates(m -> m.resource().is(order))
                .forMessageType(LineItemStateTransitionMessage.MESSAGE_HINT);
        assertEventually(() -> {
            final Optional<LineItemStateTransitionMessage> lineItemStateTransitionMessageOptional = client().executeBlocking(messageQuery).head();
            assertThat(lineItemStateTransitionMessageOptional).isPresent();

            final LineItemStateTransitionMessage lineItemStateTransitionMessage = lineItemStateTransitionMessageOptional.get();

            final String lineItemIdFromMessage = lineItemStateTransitionMessage.getLineItemId();
            assertThat(lineItemIdFromMessage).isEqualTo(order.getLineItems().get(0).getId());
            final ZonedDateTime transitionDateFromMessage = lineItemStateTransitionMessage.getTransitionDate();
            assertThat(transitionDateFromMessage).isEqualTo(actualTransitionDate);
            final Long quantityFromMessage = lineItemStateTransitionMessage.getQuantity();
            assertThat(quantityFromMessage).isEqualTo(quantity);
            final Reference<State> fromStateReference = lineItemStateTransitionMessage.getFromState();
            assertThat(fromStateReference).isEqualTo(initialState.toReference());
            final Reference<State> toStateReference = lineItemStateTransitionMessage.getToState();
            assertThat(toStateReference).isEqualTo(nextState.toReference());
        });

        return updatedOrder;
    })
);
See the test code.

Field Summary

Fields

Modifier and Type	Field and Description
protected ZonedDateTime	actualTransitionDate
protected Reference<State>	fromState
protected Long	quantity
protected Reference<State>	toState

Method Summary

Modifier and Type	Method and Description
ZonedDateTime	getActualTransitionDate()
Reference<State>	getFromState()
String	getLineItemId()
Long	getQuantity()
Reference<State>	getToState()
static UpdateAction<Order>	of(LineItem lineItem, long quantity, Referenceable<State> fromState, Referenceable<State> toState)
static UpdateAction<Order>	of(LineItem lineItem, long quantity, Referenceable<State> fromState, Referenceable<State> toState, ZonedDateTime actualTransitionDate)
static TransitionLineItemState	of(String lineItemId, long quantity, Referenceable<State> fromState, Referenceable<State> toState, ZonedDateTime actualTransitionDate)

Methods inherited from class io.sphere.sdk.commands.UpdateActionImpl

getAction

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

quantity

protected final Long quantity

fromState

protected final Reference<State> fromState

toState

protected final Reference<State> toState

actualTransitionDate

@Nullable
protected final ZonedDateTime actualTransitionDate

Method Detail

getLineItemId

public String getLineItemId()

of

public static TransitionLineItemState of(String lineItemId,
                                         long quantity,
                                         Referenceable<State> fromState,
                                         Referenceable<State> toState,
                                         ZonedDateTime actualTransitionDate)

of

public static UpdateAction<Order> of(LineItem lineItem,
                                     long quantity,
                                     Referenceable<State> fromState,
                                     Referenceable<State> toState,
                                     ZonedDateTime actualTransitionDate)

of

public static UpdateAction<Order> of(LineItem lineItem,
                                     long quantity,
                                     Referenceable<State> fromState,
                                     Referenceable<State> toState)

getQuantity

public Long getQuantity()

getFromState

public Reference<State> getFromState()

getToState

public Reference<State> getToState()

getActualTransitionDate

@Nullable
public ZonedDateTime getActualTransitionDate()