Package com.commercetools.api.models.order

Interface OrderTransitionLineItemStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderTransitionLineItemStateActionImpl

public interface OrderTransitionLineItemStateAction
extends OrderUpdateAction

Produces the Line Item State Transition Message.

Example to create an instance using the builder pattern

     OrderTransitionLineItemStateAction orderTransitionLineItemStateAction = OrderTransitionLineItemStateAction.builder()
             .quantity(0.3)
             .fromState(fromStateBuilder -> fromStateBuilder)
             .toState(toStateBuilder -> toStateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRANSITION_LINE_ITEM_STATE	discriminator value for OrderTransitionLineItemStateAction

Method Summary

Modifier and Type	Method	Description
static OrderTransitionLineItemStateActionBuilder	builder()	builder factory method for OrderTransitionLineItemStateAction
static OrderTransitionLineItemStateActionBuilder	builder(OrderTransitionLineItemStateAction template)	create builder for OrderTransitionLineItemStateAction instance
static OrderTransitionLineItemStateAction	deepCopy(OrderTransitionLineItemStateAction template)	factory method to create a deep copy of OrderTransitionLineItemStateAction
ZonedDateTime	getActualTransitionDate()	Date and time (UTC) to perform the State transition.
@NotNull @Valid StateResourceIdentifier	getFromState()	State the Line Item should transition from.
String	getLineItemId()	id of the LineItem to update.
String	getLineItemKey()	key of the LineItem to update.
@NotNull Long	getQuantity()	Number of Line Items that should transition State.
@NotNull @Valid StateResourceIdentifier	getToState()	State the Line Item should transition to.
static OrderTransitionLineItemStateAction	of()	factory method
static OrderTransitionLineItemStateAction	of(OrderTransitionLineItemStateAction template)	factory method to create a shallow copy OrderTransitionLineItemStateAction
void	setActualTransitionDate(ZonedDateTime actualTransitionDate)	Date and time (UTC) to perform the State transition.
void	setFromState(StateResourceIdentifier fromState)	State the Line Item should transition from.
void	setLineItemId(String lineItemId)	id of the LineItem to update.
void	setLineItemKey(String lineItemKey)	key of the LineItem to update.
void	setQuantity(Long quantity)	Number of Line Items that should transition State.
void	setToState(StateResourceIdentifier toState)	State the Line Item should transition to.
static com.fasterxml.jackson.core.type.TypeReference<OrderTransitionLineItemStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderTransitionLineItemStateAction(Function<OrderTransitionLineItemStateAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.order.OrderUpdateAction

getAction, withOrderUpdateAction

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

get

Field Details

TRANSITION_LINE_ITEM_STATE

static final String TRANSITION_LINE_ITEM_STATE

discriminator value for OrderTransitionLineItemStateAction

See Also:

• Constant Field Values

Method Details

getLineItemId

String getLineItemId()

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemId

getLineItemKey

String getLineItemKey()

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Returns:

lineItemKey

getQuantity

@NotNull
@NotNull Long getQuantity()

Number of Line Items that should transition State.

Returns:

quantity

getFromState

@NotNull
@Valid
@NotNull @Valid StateResourceIdentifier getFromState()

State the Line Item should transition from.

Returns:

fromState

getToState

@NotNull
@Valid
@NotNull @Valid StateResourceIdentifier getToState()

State the Line Item should transition to.

Returns:

toState

getActualTransitionDate

ZonedDateTime getActualTransitionDate()

Date and time (UTC) to perform the State transition.

Returns:

actualTransitionDate

setLineItemId

void setLineItemId(String lineItemId)

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemId - value to be set

setLineItemKey

void setLineItemKey(String lineItemKey)

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Parameters:

lineItemKey - value to be set

setQuantity

void setQuantity(Long quantity)

Number of Line Items that should transition State.

Parameters:

quantity - value to be set

setFromState

void setFromState(StateResourceIdentifier fromState)

State the Line Item should transition from.

Parameters:

fromState - value to be set

setToState

void setToState(StateResourceIdentifier toState)

State the Line Item should transition to.

Parameters:

toState - value to be set

setActualTransitionDate

void setActualTransitionDate(ZonedDateTime actualTransitionDate)

Date and time (UTC) to perform the State transition.

Parameters:

actualTransitionDate - value to be set

of

static OrderTransitionLineItemStateAction of()

factory method

Returns:

instance of OrderTransitionLineItemStateAction

of

static OrderTransitionLineItemStateAction of(OrderTransitionLineItemStateAction template)

factory method to create a shallow copy OrderTransitionLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderTransitionLineItemStateAction deepCopy(@Nullable
 OrderTransitionLineItemStateAction template)

factory method to create a deep copy of OrderTransitionLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderTransitionLineItemStateActionBuilder builder()

builder factory method for OrderTransitionLineItemStateAction

Returns:

builder

builder

static OrderTransitionLineItemStateActionBuilder builder(OrderTransitionLineItemStateAction template)

create builder for OrderTransitionLineItemStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderTransitionLineItemStateAction

default <T> T withOrderTransitionLineItemStateAction(Function<OrderTransitionLineItemStateAction,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<OrderTransitionLineItemStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference