Package com.commercetools.api.models.order_edit

Class StagedOrderSetReturnItemCustomFieldActionBuilder

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderSetReturnItemCustomFieldActionBuilder

All Implemented Interfaces:

Builder<StagedOrderSetReturnItemCustomFieldAction>

public class StagedOrderSetReturnItemCustomFieldActionBuilder
extends Object
implements Builder<StagedOrderSetReturnItemCustomFieldAction>

StagedOrderSetReturnItemCustomFieldActionBuilder Example to create an instance using the builder pattern

     StagedOrderSetReturnItemCustomFieldAction stagedOrderSetReturnItemCustomFieldAction = StagedOrderSetReturnItemCustomFieldAction.builder()
             .name("{name}")
             .build()
 

Constructor Summary

Constructors

Constructor	Description
StagedOrderSetReturnItemCustomFieldActionBuilder()

Method Summary

Modifier and Type	Method	Description
StagedOrderSetReturnItemCustomFieldAction	build()	builds StagedOrderSetReturnItemCustomFieldAction with checking for non-null required values
StagedOrderSetReturnItemCustomFieldAction	buildUnchecked()	builds StagedOrderSetReturnItemCustomFieldAction without checking for non-null required values
String	getName()	Name of the Custom Field.
String	getReturnItemId()	id of the ReturnItem to update.
String	getReturnItemKey()	key of the ReturnItem to update.
Object	getValue()	If value is absent or null, this field will be removed if it exists.
StagedOrderSetReturnItemCustomFieldActionBuilder	name(String name)	Name of the Custom Field.
static StagedOrderSetReturnItemCustomFieldActionBuilder	of()	factory method for an instance of StagedOrderSetReturnItemCustomFieldActionBuilder
static StagedOrderSetReturnItemCustomFieldActionBuilder	of(StagedOrderSetReturnItemCustomFieldAction template)	create builder for StagedOrderSetReturnItemCustomFieldAction instance
StagedOrderSetReturnItemCustomFieldActionBuilder	returnItemId(String returnItemId)	id of the ReturnItem to update.
StagedOrderSetReturnItemCustomFieldActionBuilder	returnItemKey(String returnItemKey)	key of the ReturnItem to update.
StagedOrderSetReturnItemCustomFieldActionBuilder	value(Object value)	If value is absent or null, this field will be removed if it exists.

Methods inherited from class java.lang.Object

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

Constructor Details

StagedOrderSetReturnItemCustomFieldActionBuilder

public StagedOrderSetReturnItemCustomFieldActionBuilder()

Method Details

returnItemId

public StagedOrderSetReturnItemCustomFieldActionBuilder 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 StagedOrderSetReturnItemCustomFieldActionBuilder returnItemKey(@Nullable
 String returnItemKey)

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

Parameters:

returnItemKey - value to be set

Returns:

Builder

name

public StagedOrderSetReturnItemCustomFieldActionBuilder name(String name)

Name of the Custom Field.

Parameters:

name - value to be set

Returns:

Builder

value

public StagedOrderSetReturnItemCustomFieldActionBuilder value(@Nullable
 Object value)

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Parameters:

value - 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

getName

public String getName()

Name of the Custom Field.

Returns:

name

getValue

@Nullable
public Object getValue()

If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.

Returns:

value

build

public StagedOrderSetReturnItemCustomFieldAction build()

builds StagedOrderSetReturnItemCustomFieldAction with checking for non-null required values

Specified by:

build in interface Builder<StagedOrderSetReturnItemCustomFieldAction>

Returns:

StagedOrderSetReturnItemCustomFieldAction

buildUnchecked

public StagedOrderSetReturnItemCustomFieldAction buildUnchecked()

builds StagedOrderSetReturnItemCustomFieldAction without checking for non-null required values

Returns:

StagedOrderSetReturnItemCustomFieldAction

of

public static StagedOrderSetReturnItemCustomFieldActionBuilder of()

factory method for an instance of StagedOrderSetReturnItemCustomFieldActionBuilder

Returns:

builder

of

public static StagedOrderSetReturnItemCustomFieldActionBuilder of(StagedOrderSetReturnItemCustomFieldAction template)

create builder for StagedOrderSetReturnItemCustomFieldAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder