Package com.commercetools.api.models.order

Class OrderSetShippingCustomTypeActionBuilder

java.lang.Object

com.commercetools.api.models.order.OrderSetShippingCustomTypeActionBuilder

All Implemented Interfaces:

Builder<OrderSetShippingCustomTypeAction>

public class OrderSetShippingCustomTypeActionBuilder
extends Object
implements Builder<OrderSetShippingCustomTypeAction>

OrderSetShippingCustomTypeActionBuilder Example to create an instance using the builder pattern

     OrderSetShippingCustomTypeAction orderSetShippingCustomTypeAction = OrderSetShippingCustomTypeAction.builder()
             .build()
 

Constructor Summary

Constructors

Constructor	Description
OrderSetShippingCustomTypeActionBuilder()

Method Summary

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

OrderSetShippingCustomTypeActionBuilder

public OrderSetShippingCustomTypeActionBuilder()

Method Details

shippingKey

public OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeActionBuilder 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 OrderSetShippingCustomTypeAction build()

builds OrderSetShippingCustomTypeAction with checking for non-null required values

Specified by:

build in interface Builder<OrderSetShippingCustomTypeAction>

Returns:

OrderSetShippingCustomTypeAction

buildUnchecked

public OrderSetShippingCustomTypeAction buildUnchecked()

builds OrderSetShippingCustomTypeAction without checking for non-null required values

Returns:

OrderSetShippingCustomTypeAction

of

public static OrderSetShippingCustomTypeActionBuilder of()

factory method for an instance of OrderSetShippingCustomTypeActionBuilder

Returns:

builder

of

public static OrderSetShippingCustomTypeActionBuilder of(OrderSetShippingCustomTypeAction template)

create builder for OrderSetShippingCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder