Package com.commercetools.api.models.customer

Interface CustomerSetDefaultShippingAddressAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerSetDefaultShippingAddressAction
extends CustomerUpdateAction

Sets the default shipping address from addresses. The action adds the id of the specified address to the shippingAddressIds if not contained already. Either addressId or addressKey is required.

This action generates the CustomerDefaultShippingAddressSet Message.

Example to create an instance using the builder pattern

     CustomerSetDefaultShippingAddressAction customerSetDefaultShippingAddressAction = CustomerSetDefaultShippingAddressAction.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_DEFAULT_SHIPPING_ADDRESS	discriminator value for CustomerSetDefaultShippingAddressAction

Method Summary

Modifier and Type	Method	Description
static CustomerSetDefaultShippingAddressActionBuilder	builder()	builder factory method for CustomerSetDefaultShippingAddressAction
static CustomerSetDefaultShippingAddressActionBuilder	builder(CustomerSetDefaultShippingAddressAction template)	create builder for CustomerSetDefaultShippingAddressAction instance
CustomerSetDefaultShippingAddressAction	copyDeep()
static CustomerSetDefaultShippingAddressAction	deepCopy(CustomerSetDefaultShippingAddressAction template)	factory method to create a deep copy of CustomerSetDefaultShippingAddressAction
String	getAddressId()	id of the Address to become the default shipping address.
String	getAddressKey()	key of the Address to become the default shipping address.
static CustomerSetDefaultShippingAddressAction	of()	factory method
static CustomerSetDefaultShippingAddressAction	of(CustomerSetDefaultShippingAddressAction template)	factory method to create a shallow copy CustomerSetDefaultShippingAddressAction
void	setAddressId(String addressId)	id of the Address to become the default shipping address.
void	setAddressKey(String addressKey)	key of the Address to become the default shipping address.
static com.fasterxml.jackson.core.type.TypeReference<CustomerSetDefaultShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerSetDefaultShippingAddressAction(Function<CustomerSetDefaultShippingAddressAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.customer.CustomerUpdateAction

getAction, withCustomerUpdateAction

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

get

Field Details

SET_DEFAULT_SHIPPING_ADDRESS

static final String SET_DEFAULT_SHIPPING_ADDRESS

discriminator value for CustomerSetDefaultShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

id of the Address to become the default shipping address.

Returns:

addressId

getAddressKey

String getAddressKey()

key of the Address to become the default shipping address.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

id of the Address to become the default shipping address.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

key of the Address to become the default shipping address.

Parameters:

addressKey - value to be set

of

static CustomerSetDefaultShippingAddressAction of()

factory method

Returns:

instance of CustomerSetDefaultShippingAddressAction

of

static CustomerSetDefaultShippingAddressAction of(CustomerSetDefaultShippingAddressAction template)

factory method to create a shallow copy CustomerSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerSetDefaultShippingAddressAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerSetDefaultShippingAddressAction deepCopy(@Nullable
 CustomerSetDefaultShippingAddressAction template)

factory method to create a deep copy of CustomerSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetDefaultShippingAddressActionBuilder builder()

builder factory method for CustomerSetDefaultShippingAddressAction

Returns:

builder

builder

static CustomerSetDefaultShippingAddressActionBuilder builder(CustomerSetDefaultShippingAddressAction template)

create builder for CustomerSetDefaultShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetDefaultShippingAddressAction

default <T> T withCustomerSetDefaultShippingAddressAction(Function<CustomerSetDefaultShippingAddressAction,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<CustomerSetDefaultShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference