Package com.commercetools.api.models.order_edit

Class StagedOrderSetReturnShipmentStateActionBuilder

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderSetReturnShipmentStateActionBuilder

All Implemented Interfaces:

Builder<StagedOrderSetReturnShipmentStateAction>

public class StagedOrderSetReturnShipmentStateActionBuilder
extends Object
implements Builder<StagedOrderSetReturnShipmentStateAction>

StagedOrderSetReturnShipmentStateActionBuilder Example to create an instance using the builder pattern

     StagedOrderSetReturnShipmentStateAction stagedOrderSetReturnShipmentStateAction = StagedOrderSetReturnShipmentStateAction.builder()
             .shipmentState(ReturnShipmentState.ADVISED)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
StagedOrderSetReturnShipmentStateActionBuilder()

Method Summary

Modifier and Type	Method	Description
StagedOrderSetReturnShipmentStateAction	build()	builds StagedOrderSetReturnShipmentStateAction with checking for non-null required values
StagedOrderSetReturnShipmentStateAction	buildUnchecked()	builds StagedOrderSetReturnShipmentStateAction without checking for non-null required values
String	getReturnItemId()	id of the ReturnItem to update.
String	getReturnItemKey()	key of the ReturnItem to update.
ReturnShipmentState	getShipmentState()	New shipment state of the ReturnItem.
static StagedOrderSetReturnShipmentStateActionBuilder	of()	factory method for an instance of StagedOrderSetReturnShipmentStateActionBuilder
static StagedOrderSetReturnShipmentStateActionBuilder	of(StagedOrderSetReturnShipmentStateAction template)	create builder for StagedOrderSetReturnShipmentStateAction instance
StagedOrderSetReturnShipmentStateActionBuilder	returnItemId(String returnItemId)	id of the ReturnItem to update.
StagedOrderSetReturnShipmentStateActionBuilder	returnItemKey(String returnItemKey)	key of the ReturnItem to update.
StagedOrderSetReturnShipmentStateActionBuilder	shipmentState(ReturnShipmentState shipmentState)	New shipment state of the ReturnItem.

Methods inherited from class java.lang.Object

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

Constructor Details

StagedOrderSetReturnShipmentStateActionBuilder

public StagedOrderSetReturnShipmentStateActionBuilder()

Method Details

returnItemId

public StagedOrderSetReturnShipmentStateActionBuilder returnItemId(@Nullable
 String returnItemId)

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Parameters:

returnItemId - value to be set

Returns:

Builder

returnItemKey

public StagedOrderSetReturnShipmentStateActionBuilder returnItemKey(@Nullable
 String returnItemKey)

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Parameters:

returnItemKey - value to be set

Returns:

Builder

shipmentState

public StagedOrderSetReturnShipmentStateActionBuilder shipmentState(ReturnShipmentState shipmentState)

New shipment state of the ReturnItem.

Parameters:

shipmentState - value to be set

Returns:

Builder

getReturnItemId

@Nullable
public String getReturnItemId()

id of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Returns:

returnItemId

getReturnItemKey

@Nullable
public String getReturnItemKey()

key of the ReturnItem to update. Either returnItemId or returnItemKey is required.

Returns:

returnItemKey

getShipmentState

public ReturnShipmentState getShipmentState()

New shipment state of the ReturnItem.

Returns:

shipmentState

build

public StagedOrderSetReturnShipmentStateAction build()

builds StagedOrderSetReturnShipmentStateAction with checking for non-null required values

Specified by:

build in interface Builder<StagedOrderSetReturnShipmentStateAction>

Returns:

StagedOrderSetReturnShipmentStateAction

buildUnchecked

public StagedOrderSetReturnShipmentStateAction buildUnchecked()

builds StagedOrderSetReturnShipmentStateAction without checking for non-null required values

Returns:

StagedOrderSetReturnShipmentStateAction

of

public static StagedOrderSetReturnShipmentStateActionBuilder of()

factory method for an instance of StagedOrderSetReturnShipmentStateActionBuilder

Returns:

builder

of

public static StagedOrderSetReturnShipmentStateActionBuilder of(StagedOrderSetReturnShipmentStateAction template)

create builder for StagedOrderSetReturnShipmentStateAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder