Package com.commercetools.api.models.order

Interface ReturnItem

All Superinterfaces:

Customizable<ReturnItem>

All Known Subinterfaces:

CustomLineItemReturnItem, LineItemReturnItem

All Known Implementing Classes:

CustomLineItemReturnItemImpl, LineItemReturnItemImpl, ReturnItemImpl

public interface ReturnItem
extends Customizable<ReturnItem>

ReturnItem Example to create a subtype instance using the builder pattern

     ReturnItem returnItem = ReturnItem.customLineItemReturnItemBuilder()
             id("{id}")
             quantity(0.3)
             shipmentState(ReturnShipmentState.ADVISED)
             paymentState(ReturnPaymentState.NON_REFUNDABLE)
             lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
             customLineItemId("{customLineItemId}")
             .build()
 

Method Summary

Modifier and Type	Method	Description
static CustomLineItemReturnItemBuilder	customLineItemReturnItemBuilder()	builder for customLineItemReturnItem subtype
static ReturnItem	deepCopy(ReturnItem template)	factory method to create a deep copy of ReturnItem
String	getComment()
@NotNull ZonedDateTime	getCreatedAt()
@Valid CustomFields	getCustom()	Custom Fields of this return item.
@NotNull String	getId()	Unique identifier of the ReturnItem.
@NotNull ZonedDateTime	getLastModifiedAt()
@NotNull ReturnPaymentState	getPaymentState()
@NotNull Long	getQuantity()
@NotNull ReturnShipmentState	getShipmentState()
@NotNull String	getType()
static LineItemReturnItemBuilder	lineItemReturnItemBuilder()	builder for lineItemReturnItem subtype
void	setComment(String comment)	set comment
void	setCreatedAt(ZonedDateTime createdAt)	set createdAt
void	setCustom(CustomFields custom)	Custom Fields of this return item.
void	setId(String id)	Unique identifier of the ReturnItem.
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)	set lastModifiedAt
void	setPaymentState(ReturnPaymentState paymentState)	set paymentState
void	setQuantity(Long quantity)	set quantity
void	setShipmentState(ReturnShipmentState shipmentState)	set shipmentState
static com.fasterxml.jackson.core.type.TypeReference<ReturnItem>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withReturnItem(Function<ReturnItem,T> helper)	accessor map function

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

unwrapCustomizable

Method Details

getId

@NotNull
@NotNull String getId()

Unique identifier of the ReturnItem.

Returns:

id

getQuantity

@NotNull
@NotNull Long getQuantity()

Returns:

quantity

getType

@NotNull
@NotNull String getType()

Returns:

type

getComment

String getComment()

Returns:

comment

getShipmentState

@NotNull
@NotNull ReturnShipmentState getShipmentState()

Returns:

shipmentState

getPaymentState

@NotNull
@NotNull ReturnPaymentState getPaymentState()

Returns:

paymentState

getCustom

@Valid
@Valid CustomFields getCustom()

Custom Fields of this return item.

Specified by:

getCustom in interface Customizable<ReturnItem>

Returns:

custom

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Returns:

lastModifiedAt

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Returns:

createdAt

setId

void setId(String id)

Unique identifier of the ReturnItem.

Parameters:

id - value to be set

setQuantity

void setQuantity(Long quantity)

set quantity

Parameters:

quantity - value to be set

setComment

void setComment(String comment)

set comment

Parameters:

comment - value to be set

setShipmentState

void setShipmentState(ReturnShipmentState shipmentState)

set shipmentState

Parameters:

shipmentState - value to be set

setPaymentState

void setPaymentState(ReturnPaymentState paymentState)

set paymentState

Parameters:

paymentState - value to be set

setCustom

void setCustom(CustomFields custom)

Custom Fields of this return item.

Specified by:

setCustom in interface Customizable<ReturnItem>

Parameters:

custom - value to be set

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

set lastModifiedAt

Parameters:

lastModifiedAt - value to be set

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

set createdAt

Parameters:

createdAt - value to be set

deepCopy

@Nullable
static ReturnItem deepCopy(@Nullable
 ReturnItem template)

factory method to create a deep copy of ReturnItem

Parameters:

template - instance to be copied

Returns:

copy instance

customLineItemReturnItemBuilder

static CustomLineItemReturnItemBuilder customLineItemReturnItemBuilder()

builder for customLineItemReturnItem subtype

Returns:

builder

lineItemReturnItemBuilder

static LineItemReturnItemBuilder lineItemReturnItemBuilder()

builder for lineItemReturnItem subtype

Returns:

builder

withReturnItem

default <T> T withReturnItem(Function<ReturnItem,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<ReturnItem> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference