Package com.commercetools.api.models.order

Interface OrderTransitionCustomLineItemStateAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

All Known Implementing Classes:

OrderTransitionCustomLineItemStateActionImpl

public interface OrderTransitionCustomLineItemStateAction
extends OrderUpdateAction

Produces the Custom Line Item State Transition Message.

Example to create an instance using the builder pattern

     OrderTransitionCustomLineItemStateAction orderTransitionCustomLineItemStateAction = OrderTransitionCustomLineItemStateAction.builder()
             .quantity(0.3)
             .fromState(fromStateBuilder -> fromStateBuilder)
             .toState(toStateBuilder -> toStateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TRANSITION_CUSTOM_LINE_ITEM_STATE	discriminator value for OrderTransitionCustomLineItemStateAction

Method Summary

Modifier and Type	Method	Description
static OrderTransitionCustomLineItemStateActionBuilder	builder()	builder factory method for OrderTransitionCustomLineItemStateAction
static OrderTransitionCustomLineItemStateActionBuilder	builder(OrderTransitionCustomLineItemStateAction template)	create builder for OrderTransitionCustomLineItemStateAction instance
static OrderTransitionCustomLineItemStateAction	deepCopy(OrderTransitionCustomLineItemStateAction template)	factory method to create a deep copy of OrderTransitionCustomLineItemStateAction
ZonedDateTime	getActualTransitionDate()	Date and time (UTC) to perform the State transition.
String	getCustomLineItemId()	id of the CustomLineItem to update.
String	getCustomLineItemKey()	key of the CustomLineItem to update.
@NotNull @Valid StateResourceIdentifier	getFromState()	State the Custom Line Item should transition from.
@NotNull Long	getQuantity()	Number of Custom Line Items that should transition State.
@NotNull @Valid StateResourceIdentifier	getToState()	State the Custom Line Item should transition to.
static OrderTransitionCustomLineItemStateAction	of()	factory method
static OrderTransitionCustomLineItemStateAction	of(OrderTransitionCustomLineItemStateAction template)	factory method to create a shallow copy OrderTransitionCustomLineItemStateAction
void	setActualTransitionDate(ZonedDateTime actualTransitionDate)	Date and time (UTC) to perform the State transition.
void	setCustomLineItemId(String customLineItemId)	id of the CustomLineItem to update.
void	setCustomLineItemKey(String customLineItemKey)	key of the CustomLineItem to update.
void	setFromState(StateResourceIdentifier fromState)	State the Custom Line Item should transition from.
void	setQuantity(Long quantity)	Number of Custom Line Items that should transition State.
void	setToState(StateResourceIdentifier toState)	State the Custom Line Item should transition to.
static com.fasterxml.jackson.core.type.TypeReference<OrderTransitionCustomLineItemStateAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderTransitionCustomLineItemStateAction(Function<OrderTransitionCustomLineItemStateAction,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_CUSTOM_LINE_ITEM_STATE

static final String TRANSITION_CUSTOM_LINE_ITEM_STATE

discriminator value for OrderTransitionCustomLineItemStateAction

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

String getCustomLineItemId()

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Returns:

customLineItemKey

getQuantity

@NotNull
@NotNull Long getQuantity()

Number of Custom Line Items that should transition State.

Returns:

quantity

getFromState

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

State the Custom Line Item should transition from.

Returns:

fromState

getToState

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

State the Custom Line Item should transition to.

Returns:

toState

getActualTransitionDate

ZonedDateTime getActualTransitionDate()

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

Returns:

actualTransitionDate

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Parameters:

customLineItemKey - value to be set

setQuantity

void setQuantity(Long quantity)

Number of Custom Line Items that should transition State.

Parameters:

quantity - value to be set

setFromState

void setFromState(StateResourceIdentifier fromState)

State the Custom Line Item should transition from.

Parameters:

fromState - value to be set

setToState

void setToState(StateResourceIdentifier toState)

State the Custom 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 OrderTransitionCustomLineItemStateAction of()

factory method

Returns:

instance of OrderTransitionCustomLineItemStateAction

of

static OrderTransitionCustomLineItemStateAction of(OrderTransitionCustomLineItemStateAction template)

factory method to create a shallow copy OrderTransitionCustomLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static OrderTransitionCustomLineItemStateAction deepCopy(@Nullable
 OrderTransitionCustomLineItemStateAction template)

factory method to create a deep copy of OrderTransitionCustomLineItemStateAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderTransitionCustomLineItemStateActionBuilder builder()

builder factory method for OrderTransitionCustomLineItemStateAction

Returns:

builder

builder

static OrderTransitionCustomLineItemStateActionBuilder builder(OrderTransitionCustomLineItemStateAction template)

create builder for OrderTransitionCustomLineItemStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderTransitionCustomLineItemStateAction

default <T> T withOrderTransitionCustomLineItemStateAction(Function<OrderTransitionCustomLineItemStateAction,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<OrderTransitionCustomLineItemStateAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference