Package com.commercetools.api.models.order

Class LineItemReturnItemBuilder

java.lang.Object

com.commercetools.api.models.order.LineItemReturnItemBuilder

All Implemented Interfaces:

io.vrap.rmf.base.client.Builder<LineItemReturnItem>

public class LineItemReturnItemBuilder
extends Object
implements io.vrap.rmf.base.client.Builder<LineItemReturnItem>

LineItemReturnItemBuilder Example to create an instance using the builder pattern

     LineItemReturnItem lineItemReturnItem = LineItemReturnItem.builder()
             .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"))
             .lineItemId("{lineItemId}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
LineItemReturnItemBuilder()

Method Summary

Modifier and Type	Method	Description
LineItemReturnItem	build()	builds LineItemReturnItem with checking for non-null required values
LineItemReturnItem	buildUnchecked()	builds LineItemReturnItem without checking for non-null required values
LineItemReturnItemBuilder	comment(String comment)	set the value to the comment
LineItemReturnItemBuilder	createdAt(ZonedDateTime createdAt)	set the value to the createdAt
LineItemReturnItemBuilder	custom(CustomFields custom)	Custom Fields of this return item.
LineItemReturnItemBuilder	custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)	Custom Fields of this return item.
String	getComment()	value of comment}
ZonedDateTime	getCreatedAt()	value of createdAt}
CustomFields	getCustom()	Custom Fields of this return item.
String	getId()	Unique identifier of the ReturnItem.
ZonedDateTime	getLastModifiedAt()	value of lastModifiedAt}
String	getLineItemId()	value of lineItemId}
ReturnPaymentState	getPaymentState()	value of paymentState}
Long	getQuantity()	value of quantity}
ReturnShipmentState	getShipmentState()	value of shipmentState}
LineItemReturnItemBuilder	id(String id)	Unique identifier of the ReturnItem.
LineItemReturnItemBuilder	lastModifiedAt(ZonedDateTime lastModifiedAt)	set the value to the lastModifiedAt
LineItemReturnItemBuilder	lineItemId(String lineItemId)	set the value to the lineItemId
static LineItemReturnItemBuilder	of()	factory method for an instance of LineItemReturnItemBuilder
static LineItemReturnItemBuilder	of(LineItemReturnItem template)	create builder for LineItemReturnItem instance
LineItemReturnItemBuilder	paymentState(ReturnPaymentState paymentState)	set the value to the paymentState
LineItemReturnItemBuilder	quantity(Long quantity)	set the value to the quantity
LineItemReturnItemBuilder	shipmentState(ReturnShipmentState shipmentState)	set the value to the shipmentState
LineItemReturnItemBuilder	withCustom(Function<CustomFieldsBuilder,CustomFields> builder)	Custom Fields of this return item.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LineItemReturnItemBuilder

public LineItemReturnItemBuilder()

Method Details

id

public LineItemReturnItemBuilder id(String id)

Unique identifier of the ReturnItem.

Parameters:

id - value to be set

Returns:

Builder

quantity

public LineItemReturnItemBuilder quantity(Long quantity)

set the value to the quantity

Parameters:

quantity - value to be set

Returns:

Builder

comment

public LineItemReturnItemBuilder comment(@Nullable
 String comment)

set the value to the comment

Parameters:

comment - value to be set

Returns:

Builder

shipmentState

public LineItemReturnItemBuilder shipmentState(ReturnShipmentState shipmentState)

set the value to the shipmentState

Parameters:

shipmentState - value to be set

Returns:

Builder

paymentState

public LineItemReturnItemBuilder paymentState(ReturnPaymentState paymentState)

set the value to the paymentState

Parameters:

paymentState - value to be set

Returns:

Builder

custom

public LineItemReturnItemBuilder custom(Function<CustomFieldsBuilder,CustomFieldsBuilder> builder)

Custom Fields of this return item.

Parameters:

builder - function to build the custom value

Returns:

Builder

withCustom

public LineItemReturnItemBuilder withCustom(Function<CustomFieldsBuilder,CustomFields> builder)

Custom Fields of this return item.

Parameters:

builder - function to build the custom value

Returns:

Builder

custom

public LineItemReturnItemBuilder custom(@Nullable
 CustomFields custom)

Custom Fields of this return item.

Parameters:

custom - value to be set

Returns:

Builder

lastModifiedAt

public LineItemReturnItemBuilder lastModifiedAt(ZonedDateTime lastModifiedAt)

set the value to the lastModifiedAt

Parameters:

lastModifiedAt - value to be set

Returns:

Builder

createdAt

public LineItemReturnItemBuilder createdAt(ZonedDateTime createdAt)

set the value to the createdAt

Parameters:

createdAt - value to be set

Returns:

Builder

lineItemId

public LineItemReturnItemBuilder lineItemId(String lineItemId)

set the value to the lineItemId

Parameters:

lineItemId - value to be set

Returns:

Builder

getId

public String getId()

Unique identifier of the ReturnItem.

Returns:

id

getQuantity

public Long getQuantity()

value of quantity}

Returns:

quantity

getComment

@Nullable
public String getComment()

value of comment}

Returns:

comment

getShipmentState

public ReturnShipmentState getShipmentState()

value of shipmentState}

Returns:

shipmentState

getPaymentState

public ReturnPaymentState getPaymentState()

value of paymentState}

Returns:

paymentState

getCustom

@Nullable
public CustomFields getCustom()

Custom Fields of this return item.

Returns:

custom

getLastModifiedAt

public ZonedDateTime getLastModifiedAt()

value of lastModifiedAt}

Returns:

lastModifiedAt

getCreatedAt

public ZonedDateTime getCreatedAt()

value of createdAt}

Returns:

createdAt

getLineItemId

public String getLineItemId()

value of lineItemId}

Returns:

lineItemId

build

public LineItemReturnItem build()

builds LineItemReturnItem with checking for non-null required values

Specified by:

build in interface io.vrap.rmf.base.client.Builder<LineItemReturnItem>

Returns:

LineItemReturnItem

buildUnchecked

public LineItemReturnItem buildUnchecked()

builds LineItemReturnItem without checking for non-null required values

Returns:

LineItemReturnItem

of

public static LineItemReturnItemBuilder of()

factory method for an instance of LineItemReturnItemBuilder

Returns:

builder

of

public static LineItemReturnItemBuilder of(LineItemReturnItem template)

create builder for LineItemReturnItem instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder