Interface ReturnItem
- All Superinterfaces:
Customizable<ReturnItem>
- All Known Subinterfaces:
CustomLineItemReturnItem
,LineItemReturnItem
- All Known Implementing Classes:
CustomLineItemReturnItemImpl
,LineItemReturnItemImpl
,ReturnItemImpl
ReturnItem
Example to create a subtype instance using the builder pattern
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 TypeMethodDescriptionbuilder for customLineItemReturnItem subtypestatic ReturnItem
deepCopy
(ReturnItem template) factory method to create a deep copy of ReturnItem@NotNull ZonedDateTime
@Valid CustomFields
Custom Fields of this return item.@NotNull String
getId()
Unique identifier of the ReturnItem.@NotNull ZonedDateTime
@NotNull ReturnPaymentState
@NotNull Long
@NotNull ReturnShipmentState
@NotNull String
getType()
static LineItemReturnItemBuilder
builder for lineItemReturnItem subtypevoid
setComment
(String comment) set commentvoid
setCreatedAt
(ZonedDateTime createdAt) set createdAtvoid
setCustom
(CustomFields custom) Custom Fields of this return item.void
Unique identifier of the ReturnItem.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) set lastModifiedAtvoid
setPaymentState
(ReturnPaymentState paymentState) set paymentStatevoid
setQuantity
(Long quantity) set quantityvoid
setShipmentState
(ReturnShipmentState shipmentState) set shipmentStatestatic com.fasterxml.jackson.core.type.TypeReference<ReturnItem>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withReturnItem
(Function<ReturnItem, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
-
Method Details
-
getId
Unique identifier of the ReturnItem.
- Returns:
- id
-
getQuantity
- Returns:
- quantity
-
getType
- Returns:
- type
-
getComment
- Returns:
- comment
-
getShipmentState
- Returns:
- shipmentState
-
getPaymentState
- Returns:
- paymentState
-
getCustom
Custom Fields of this return item.
- Specified by:
getCustom
in interfaceCustomizable<ReturnItem>
- Returns:
- custom
-
getLastModifiedAt
- Returns:
- lastModifiedAt
-
getCreatedAt
- Returns:
- createdAt
-
setId
Unique identifier of the ReturnItem.
- Parameters:
id
- value to be set
-
setQuantity
set quantity- Parameters:
quantity
- value to be set
-
setComment
set comment- Parameters:
comment
- value to be set
-
setShipmentState
set shipmentState- Parameters:
shipmentState
- value to be set
-
setPaymentState
set paymentState- Parameters:
paymentState
- value to be set
-
setCustom
Custom Fields of this return item.
- Specified by:
setCustom
in interfaceCustomizable<ReturnItem>
- Parameters:
custom
- value to be set
-
setLastModifiedAt
set lastModifiedAt- Parameters:
lastModifiedAt
- value to be set
-
setCreatedAt
set createdAt- Parameters:
createdAt
- value to be set
-
deepCopy
factory method to create a deep copy of ReturnItem- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
customLineItemReturnItemBuilder
builder for customLineItemReturnItem subtype- Returns:
- builder
-
lineItemReturnItemBuilder
builder for lineItemReturnItem subtype- Returns:
- builder
-
withReturnItem
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-