Package com.commercetools.api.models.message

Interface CustomLineItemStateTransitionMessagePayload

All Superinterfaces:

MessagePayload, OrderMessagePayload

All Known Implementing Classes:

CustomLineItemStateTransitionMessagePayloadImpl

public interface CustomLineItemStateTransitionMessagePayload
extends OrderMessagePayload

Generated after a successful Transition CustomLineItem State update action.

Example to create an instance using the builder pattern

     CustomLineItemStateTransitionMessagePayload customLineItemStateTransitionMessagePayload = CustomLineItemStateTransitionMessagePayload.builder()
             .customLineItemId("{customLineItemId}")
             .transitionDate(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             .quantity(0.3)
             .fromState(fromStateBuilder -> fromStateBuilder)
             .toState(toStateBuilder -> toStateBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CUSTOM_LINE_ITEM_STATE_TRANSITION	discriminator value for CustomLineItemStateTransitionMessagePayload

Method Summary

Modifier and Type	Method	Description
static CustomLineItemStateTransitionMessagePayloadBuilder	builder()	builder factory method for CustomLineItemStateTransitionMessagePayload
static CustomLineItemStateTransitionMessagePayloadBuilder	builder(CustomLineItemStateTransitionMessagePayload template)	create builder for CustomLineItemStateTransitionMessagePayload instance
static CustomLineItemStateTransitionMessagePayload	deepCopy(CustomLineItemStateTransitionMessagePayload template)	factory method to create a deep copy of CustomLineItemStateTransitionMessagePayload
@NotNull String	getCustomLineItemId()	Unique identifier of the Custom Line Item.
String	getCustomLineItemKey()	User-defined unique identifier of the Custom Line Item.
@NotNull @Valid StateReference	getFromState()	State the Custom Line Item was transitioned from.
@NotNull Long	getQuantity()	Number of Custom Line Items for which the State was transitioned.
@NotNull @Valid StateReference	getToState()	State the Custom Line Item was transitioned to.
@NotNull ZonedDateTime	getTransitionDate()	Date and time (UTC) when the transition of the Custom Line Item State was performed.
static CustomLineItemStateTransitionMessagePayload	of()	factory method
static CustomLineItemStateTransitionMessagePayload	of(CustomLineItemStateTransitionMessagePayload template)	factory method to create a shallow copy CustomLineItemStateTransitionMessagePayload
void	setCustomLineItemId(String customLineItemId)	Unique identifier of the Custom Line Item.
void	setCustomLineItemKey(String customLineItemKey)	User-defined unique identifier of the Custom Line Item.
void	setFromState(StateReference fromState)	State the Custom Line Item was transitioned from.
void	setQuantity(Long quantity)	Number of Custom Line Items for which the State was transitioned.
void	setToState(StateReference toState)	State the Custom Line Item was transitioned to.
void	setTransitionDate(ZonedDateTime transitionDate)	Date and time (UTC) when the transition of the Custom Line Item State was performed.
static com.fasterxml.jackson.core.type.TypeReference<CustomLineItemStateTransitionMessagePayload>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomLineItemStateTransitionMessagePayload(Function<CustomLineItemStateTransitionMessagePayload,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.message.MessagePayload

getType, withMessagePayload

Methods inherited from interface com.commercetools.api.models.message.OrderMessagePayload

withOrderMessagePayload

Field Details

CUSTOM_LINE_ITEM_STATE_TRANSITION

static final String CUSTOM_LINE_ITEM_STATE_TRANSITION

discriminator value for CustomLineItemStateTransitionMessagePayload

See Also:

• Constant Field Values

Method Details

getCustomLineItemId

@NotNull
@NotNull String getCustomLineItemId()

Unique identifier of the Custom Line Item.

Returns:

customLineItemId

getCustomLineItemKey

String getCustomLineItemKey()

User-defined unique identifier of the Custom Line Item.

Returns:

customLineItemKey

getTransitionDate

@NotNull
@NotNull ZonedDateTime getTransitionDate()

Date and time (UTC) when the transition of the Custom Line Item State was performed.

Returns:

transitionDate

getQuantity

@NotNull
@NotNull Long getQuantity()

Number of Custom Line Items for which the State was transitioned.

Returns:

quantity

getFromState

@NotNull
@Valid
@NotNull @Valid StateReference getFromState()

State the Custom Line Item was transitioned from.

Returns:

fromState

getToState

@NotNull
@Valid
@NotNull @Valid StateReference getToState()

State the Custom Line Item was transitioned to.

Returns:

toState

setCustomLineItemId

void setCustomLineItemId(String customLineItemId)

Unique identifier of the Custom Line Item.

Parameters:

customLineItemId - value to be set

setCustomLineItemKey

void setCustomLineItemKey(String customLineItemKey)

User-defined unique identifier of the Custom Line Item.

Parameters:

customLineItemKey - value to be set

setTransitionDate

void setTransitionDate(ZonedDateTime transitionDate)

Date and time (UTC) when the transition of the Custom Line Item State was performed.

Parameters:

transitionDate - value to be set

setQuantity

void setQuantity(Long quantity)

Number of Custom Line Items for which the State was transitioned.

Parameters:

quantity - value to be set

setFromState

void setFromState(StateReference fromState)

State the Custom Line Item was transitioned from.

Parameters:

fromState - value to be set

setToState

void setToState(StateReference toState)

State the Custom Line Item was transitioned to.

Parameters:

toState - value to be set

of

static CustomLineItemStateTransitionMessagePayload of()

factory method

Returns:

instance of CustomLineItemStateTransitionMessagePayload

of

static CustomLineItemStateTransitionMessagePayload of(CustomLineItemStateTransitionMessagePayload template)

factory method to create a shallow copy CustomLineItemStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomLineItemStateTransitionMessagePayload deepCopy(@Nullable
 CustomLineItemStateTransitionMessagePayload template)

factory method to create a deep copy of CustomLineItemStateTransitionMessagePayload

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomLineItemStateTransitionMessagePayloadBuilder builder()

builder factory method for CustomLineItemStateTransitionMessagePayload

Returns:

builder

builder

static CustomLineItemStateTransitionMessagePayloadBuilder builder(CustomLineItemStateTransitionMessagePayload template)

create builder for CustomLineItemStateTransitionMessagePayload instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomLineItemStateTransitionMessagePayload

default <T> T withCustomLineItemStateTransitionMessagePayload(Function<CustomLineItemStateTransitionMessagePayload,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<CustomLineItemStateTransitionMessagePayload> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference