Package com.commercetools.api.models.cart

Interface CartSetShippingCustomTypeAction

All Superinterfaces:

CartUpdateAction, ResourceUpdateAction<CartUpdateAction>

All Known Implementing Classes:

CartSetShippingCustomTypeActionImpl

public interface CartSetShippingCustomTypeAction
extends CartUpdateAction

This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Cart's shippingMethod or shipping.

Example to create an instance using the builder pattern

     CartSetShippingCustomTypeAction cartSetShippingCustomTypeAction = CartSetShippingCustomTypeAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_SHIPPING_CUSTOM_TYPE	discriminator value for CartSetShippingCustomTypeAction

Method Summary

Modifier and Type	Method	Description
static CartSetShippingCustomTypeActionBuilder	builder()	builder factory method for CartSetShippingCustomTypeAction
static CartSetShippingCustomTypeActionBuilder	builder(CartSetShippingCustomTypeAction template)	create builder for CartSetShippingCustomTypeAction instance
static CartSetShippingCustomTypeAction	deepCopy(CartSetShippingCustomTypeAction template)	factory method to create a deep copy of CartSetShippingCustomTypeAction
@Valid FieldContainer	getFields()	Sets the Custom Fields fields for the shippingMethod.
String	getShippingKey()	The shippingKey of the Shipping to customize.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the specified ShippingMethod with Custom Fields.
static CartSetShippingCustomTypeAction	of()	factory method
static CartSetShippingCustomTypeAction	of(CartSetShippingCustomTypeAction template)	factory method to create a shallow copy CartSetShippingCustomTypeAction
void	setFields(FieldContainer fields)	Sets the Custom Fields fields for the shippingMethod.
void	setShippingKey(String shippingKey)	The shippingKey of the Shipping to customize.
void	setType(TypeResourceIdentifier type)	Defines the Type that extends the specified ShippingMethod with Custom Fields.
static com.fasterxml.jackson.core.type.TypeReference<CartSetShippingCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartSetShippingCustomTypeAction(Function<CartSetShippingCustomTypeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart.CartUpdateAction

getAction, withCartUpdateAction

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Field Details

SET_SHIPPING_CUSTOM_TYPE

static final String SET_SHIPPING_CUSTOM_TYPE

discriminator value for CartSetShippingCustomTypeAction

See Also:

• Constant Field Values

Method Details

getShippingKey

String getShippingKey()

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

Returns:

shippingKey

getType

@Valid
@Valid 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

@Valid
@Valid FieldContainer getFields()

Sets the Custom Fields fields for the shippingMethod.

Returns:

fields

setShippingKey

void setShippingKey(String shippingKey)

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

Parameters:

shippingKey - value to be set

setType

void setType(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

setFields

void setFields(FieldContainer fields)

Sets the Custom Fields fields for the shippingMethod.

Parameters:

fields - value to be set

of

static CartSetShippingCustomTypeAction of()

factory method

Returns:

instance of CartSetShippingCustomTypeAction

of

static CartSetShippingCustomTypeAction of(CartSetShippingCustomTypeAction template)

factory method to create a shallow copy CartSetShippingCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartSetShippingCustomTypeAction deepCopy(@Nullable
 CartSetShippingCustomTypeAction template)

factory method to create a deep copy of CartSetShippingCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartSetShippingCustomTypeActionBuilder builder()

builder factory method for CartSetShippingCustomTypeAction

Returns:

builder

builder

static CartSetShippingCustomTypeActionBuilder builder(CartSetShippingCustomTypeAction template)

create builder for CartSetShippingCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartSetShippingCustomTypeAction

default <T> T withCartSetShippingCustomTypeAction(Function<CartSetShippingCustomTypeAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CartSetShippingCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference