Package com.commercetools.api.models.order

Interface OrderSetItemShippingAddressCustomTypeAction

All Superinterfaces:

OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>

public interface OrderSetItemShippingAddressCustomTypeAction
extends OrderUpdateAction

OrderSetItemShippingAddressCustomTypeAction Example to create an instance using the builder pattern

     OrderSetItemShippingAddressCustomTypeAction orderSetItemShippingAddressCustomTypeAction = OrderSetItemShippingAddressCustomTypeAction.builder()
             .addressKey("{addressKey}")
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_ITEM_SHIPPING_ADDRESS_CUSTOM_TYPE	discriminator value for OrderSetItemShippingAddressCustomTypeAction

Method Summary

Modifier and Type	Method	Description
static OrderSetItemShippingAddressCustomTypeActionBuilder	builder()	builder factory method for OrderSetItemShippingAddressCustomTypeAction
static OrderSetItemShippingAddressCustomTypeActionBuilder	builder(OrderSetItemShippingAddressCustomTypeAction template)	create builder for OrderSetItemShippingAddressCustomTypeAction instance
OrderSetItemShippingAddressCustomTypeAction	copyDeep()
static OrderSetItemShippingAddressCustomTypeAction	deepCopy(OrderSetItemShippingAddressCustomTypeAction template)	factory method to create a deep copy of OrderSetItemShippingAddressCustomTypeAction
@NotNull String	getAddressKey()	key of the Address in itemShippingAddresses.
@Valid FieldContainer	getFields()	Object containing the Custom Fields fields for the itemShippingAddress.
@Valid TypeResourceIdentifier	getType()	Defines the Type that extends the itemShippingAddress with Custom Fields.
static OrderSetItemShippingAddressCustomTypeAction	of()	factory method
static OrderSetItemShippingAddressCustomTypeAction	of(OrderSetItemShippingAddressCustomTypeAction template)	factory method to create a shallow copy OrderSetItemShippingAddressCustomTypeAction
void	setAddressKey(String addressKey)	key of the Address in itemShippingAddresses.
void	setFields(FieldContainer fields)	Object containing the Custom Fields fields for the itemShippingAddress.
void	setType(TypeResourceIdentifier type)	Defines the Type that extends the itemShippingAddress with Custom Fields.
static tools.jackson.core.type.TypeReference<OrderSetItemShippingAddressCustomTypeAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withOrderSetItemShippingAddressCustomTypeAction(Function<OrderSetItemShippingAddressCustomTypeAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.order.OrderUpdateAction

getAction, withOrderUpdateAction

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

get

Field Details

SET_ITEM_SHIPPING_ADDRESS_CUSTOM_TYPE

static final String SET_ITEM_SHIPPING_ADDRESS_CUSTOM_TYPE

discriminator value for OrderSetItemShippingAddressCustomTypeAction

See Also:

• Constant Field Values

Method Details

getAddressKey

@NotNull
@NotNull String getAddressKey()

key of the Address in itemShippingAddresses.

Returns:

addressKey

getType

@Valid
@Valid TypeResourceIdentifier getType()

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

Returns:

type

getFields

@Valid
@Valid FieldContainer getFields()

Object containing the Custom Fields fields for the itemShippingAddress.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Returns:

fields

setAddressKey

void setAddressKey(String addressKey)

key of the Address in itemShippingAddresses.

Parameters:

addressKey - value to be set

setType

void setType(TypeResourceIdentifier type)

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

Parameters:

type - value to be set

setFields

void setFields(FieldContainer fields)

Object containing the Custom Fields fields for the itemShippingAddress.

Required if at least one Custom Field is defined as required in the fieldDefinitions of the referenced Type.

Parameters:

fields - value to be set

of

static OrderSetItemShippingAddressCustomTypeAction of()

factory method

Returns:

instance of OrderSetItemShippingAddressCustomTypeAction

of

static OrderSetItemShippingAddressCustomTypeAction of(OrderSetItemShippingAddressCustomTypeAction template)

factory method to create a shallow copy OrderSetItemShippingAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

OrderSetItemShippingAddressCustomTypeAction copyDeep()

Specified by:

copyDeep in interface OrderUpdateAction

deepCopy

@Nullable
static OrderSetItemShippingAddressCustomTypeAction deepCopy(@Nullable
 OrderSetItemShippingAddressCustomTypeAction template)

factory method to create a deep copy of OrderSetItemShippingAddressCustomTypeAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static OrderSetItemShippingAddressCustomTypeActionBuilder builder()

builder factory method for OrderSetItemShippingAddressCustomTypeAction

Returns:

builder

builder

static OrderSetItemShippingAddressCustomTypeActionBuilder builder(OrderSetItemShippingAddressCustomTypeAction template)

create builder for OrderSetItemShippingAddressCustomTypeAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withOrderSetItemShippingAddressCustomTypeAction

default <T> T withOrderSetItemShippingAddressCustomTypeAction(Function<OrderSetItemShippingAddressCustomTypeAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<OrderSetItemShippingAddressCustomTypeAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference