Package com.commercetools.api.models.order_edit

Class StagedOrderSetShippingCustomTypeActionBuilder

java.lang.Object

com.commercetools.api.models.order_edit.StagedOrderSetShippingCustomTypeActionBuilder

All Implemented Interfaces:

Builder<StagedOrderSetShippingCustomTypeAction>

public class StagedOrderSetShippingCustomTypeActionBuilder
extends Object
implements Builder<StagedOrderSetShippingCustomTypeAction>

StagedOrderSetShippingCustomTypeActionBuilder Example to create an instance using the builder pattern

     StagedOrderSetShippingCustomTypeAction stagedOrderSetShippingCustomTypeAction = StagedOrderSetShippingCustomTypeAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
StagedOrderSetShippingCustomTypeActionBuilder()

Method Summary

Modifier and Type	Method	Description
StagedOrderSetShippingCustomTypeAction	build()	builds StagedOrderSetShippingCustomTypeAction with checking for non-null required values
StagedOrderSetShippingCustomTypeAction	buildUnchecked()	builds StagedOrderSetShippingCustomTypeAction without checking for non-null required values
StagedOrderSetShippingCustomTypeActionBuilder	fields(FieldContainer fields)	Sets the Custom Fields fields for the shippingMethod.
StagedOrderSetShippingCustomTypeActionBuilder	fields(Function<FieldContainerBuilder,FieldContainerBuilder> builder)	Sets the Custom Fields fields for the shippingMethod.
FieldContainer	getFields()	Sets the Custom Fields fields for the shippingMethod.
String	getShippingKey()	The shippingKey of the Shipping to customize.
TypeResourceIdentifier	getType()	Defines the Type that extends the specified ShippingMethod with Custom Fields.
static StagedOrderSetShippingCustomTypeActionBuilder	of()	factory method for an instance of StagedOrderSetShippingCustomTypeActionBuilder
static StagedOrderSetShippingCustomTypeActionBuilder	of(StagedOrderSetShippingCustomTypeAction template)	create builder for StagedOrderSetShippingCustomTypeAction instance
StagedOrderSetShippingCustomTypeActionBuilder	shippingKey(String shippingKey)	The shippingKey of the Shipping to customize.
StagedOrderSetShippingCustomTypeActionBuilder	type(TypeResourceIdentifier type)	Defines the Type that extends the specified ShippingMethod with Custom Fields.
StagedOrderSetShippingCustomTypeActionBuilder	type(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifierBuilder> builder)	Defines the Type that extends the specified ShippingMethod with Custom Fields.
StagedOrderSetShippingCustomTypeActionBuilder	withFields(Function<FieldContainerBuilder,FieldContainer> builder)	Sets the Custom Fields fields for the shippingMethod.
StagedOrderSetShippingCustomTypeActionBuilder	withType(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifier> builder)	Defines the Type that extends the specified ShippingMethod with Custom Fields.

Methods inherited from class java.lang.Object

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

Constructor Details

StagedOrderSetShippingCustomTypeActionBuilder

public StagedOrderSetShippingCustomTypeActionBuilder()

Method Details

shippingKey

public StagedOrderSetShippingCustomTypeActionBuilder shippingKey(@Nullable
 String shippingKey)

The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Order with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order.

Parameters:

shippingKey - value to be set

Returns:

Builder

type

public StagedOrderSetShippingCustomTypeActionBuilder type(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifierBuilder> builder)

Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

Parameters:

builder - function to build the type value

Returns:

Builder

withType

public StagedOrderSetShippingCustomTypeActionBuilder withType(Function<TypeResourceIdentifierBuilder,TypeResourceIdentifier> builder)

Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

Parameters:

builder - function to build the type value

Returns:

Builder

type

public StagedOrderSetShippingCustomTypeActionBuilder type(@Nullable
 TypeResourceIdentifier type)

Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

Parameters:

type - value to be set

Returns:

Builder

fields

public StagedOrderSetShippingCustomTypeActionBuilder fields(Function<FieldContainerBuilder,FieldContainerBuilder> builder)

Sets the Custom Fields fields for the shippingMethod.

Parameters:

builder - function to build the fields value

Returns:

Builder

withFields

public StagedOrderSetShippingCustomTypeActionBuilder withFields(Function<FieldContainerBuilder,FieldContainer> builder)

Sets the Custom Fields fields for the shippingMethod.

Parameters:

builder - function to build the fields value

Returns:

Builder

fields

public StagedOrderSetShippingCustomTypeActionBuilder fields(@Nullable
 FieldContainer fields)

Sets the Custom Fields fields for the shippingMethod.

Parameters:

fields - value to be set

Returns:

Builder

getShippingKey

@Nullable
public String getShippingKey()

The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Order with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order.

Returns:

shippingKey

getType

@Nullable
public TypeResourceIdentifier getType()

Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

Returns:

type

getFields

@Nullable
public FieldContainer getFields()

Sets the Custom Fields fields for the shippingMethod.

Returns:

fields

build

public StagedOrderSetShippingCustomTypeAction build()

builds StagedOrderSetShippingCustomTypeAction with checking for non-null required values

Specified by:

build in interface Builder<StagedOrderSetShippingCustomTypeAction>

Returns:

StagedOrderSetShippingCustomTypeAction

buildUnchecked

public StagedOrderSetShippingCustomTypeAction buildUnchecked()

builds StagedOrderSetShippingCustomTypeAction without checking for non-null required values

Returns:

StagedOrderSetShippingCustomTypeAction

of

public static StagedOrderSetShippingCustomTypeActionBuilder of()

factory method for an instance of StagedOrderSetShippingCustomTypeActionBuilder

Returns:

builder

of

public static StagedOrderSetShippingCustomTypeActionBuilder of(StagedOrderSetShippingCustomTypeAction template)

create builder for StagedOrderSetShippingCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder