io.sphere.sdk.orders.commands.updateactions

Class TransitionCustomLineItemState

java.lang.Object

io.sphere.sdk.models.Base

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

io.sphere.sdk.orders.commands.updateactions.TransitionCustomLineItemState

All Implemented Interfaces:

UpdateAction<Order>

public final class TransitionCustomLineItemState
extends UpdateActionImpl<Order>

Change the state of a Custom Line Item according to allowed transitions.

See also OrderUpdateCommand.

withStandardStates(client(), (final State initialState,final State nextState) ->
    withOrderOfCustomLineItems(client(), order -> {

        final CustomLineItem customLineItem = order.getCustomLineItems().get(0);
        assertThat(customLineItem).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, TransitionCustomLineItemState.of(customLineItem, quantity, initialState, nextState, actualTransitionDate)));
        assertThat(updatedOrder.getCustomLineItems().get(0)).has(itemStates(ItemState.of(nextState, quantity)));

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

            final CustomLineItemStateTransitionMessage customLineItemStateTransitionMessage = lineItemStateTransitionMessageOptional.get();

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

    })
);
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()
String	getCustomLineItemId()
Reference<State>	getFromState()
Long	getQuantity()
Reference<State>	getToState()
static UpdateAction<Order>	of(CustomLineItem lineItem, long quantity, Referenceable<State> fromState, Referenceable<State> toState)
static UpdateAction<Order>	of(CustomLineItem lineItem, long quantity, Referenceable<State> fromState, Referenceable<State> toState, ZonedDateTime actualTransitionDate)
static TransitionCustomLineItemState	of(String customLineItemId, 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

getCustomLineItemId

public String getCustomLineItemId()

of

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

of

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

of

public static UpdateAction<Order> of(CustomLineItem 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()