Package com.commercetools.api.models.business_unit

Interface BusinessUnitSetDefaultShippingAddressAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

public interface BusinessUnitSetDefaultShippingAddressAction
extends BusinessUnitUpdateAction

Setting the default shipping address on a Business Unit generates a BusinessUnitDefaultShippingAddressSet Message.

Example to create an instance using the builder pattern

     BusinessUnitSetDefaultShippingAddressAction businessUnitSetDefaultShippingAddressAction = BusinessUnitSetDefaultShippingAddressAction.builder()
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static BusinessUnitSetDefaultShippingAddressActionBuilder	builder()	builder factory method for BusinessUnitSetDefaultShippingAddressAction
static BusinessUnitSetDefaultShippingAddressActionBuilder	builder(BusinessUnitSetDefaultShippingAddressAction template)	create builder for BusinessUnitSetDefaultShippingAddressAction instance
static BusinessUnitSetDefaultShippingAddressAction	deepCopy(BusinessUnitSetDefaultShippingAddressAction template)	factory method to create a deep copy of BusinessUnitSetDefaultShippingAddressAction
String	getAddressId()	ID of the address to add as a shipping address.
String	getAddressKey()	Key of the address to add as a shipping address.
static BusinessUnitSetDefaultShippingAddressAction	of()	factory method
static BusinessUnitSetDefaultShippingAddressAction	of(BusinessUnitSetDefaultShippingAddressAction template)	factory method to create a shallow copy BusinessUnitSetDefaultShippingAddressAction
void	setAddressId(String addressId)	ID of the address to add as a shipping address.
void	setAddressKey(String addressKey)	Key of the address to add as a shipping address.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitSetDefaultShippingAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitSetDefaultShippingAddressAction(Function<BusinessUnitSetDefaultShippingAddressAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.business_unit.BusinessUnitUpdateAction

getAction, withBusinessUnitUpdateAction

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 BusinessUnitSetDefaultShippingAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

ID of the address to add as a shipping address. Either addressId or addressKey is required.

Returns:

addressId

getAddressKey

String getAddressKey()

Key of the address to add as a shipping address. Either addressId or addressKey is required.

Returns:

addressKey

setAddressId

void setAddressId(String addressId)

ID of the address to add as a shipping address. Either addressId or addressKey is required.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

Key of the address to add as a shipping address. Either addressId or addressKey is required.

Parameters:

addressKey - value to be set

of

static BusinessUnitSetDefaultShippingAddressAction of()

factory method

Returns:

instance of BusinessUnitSetDefaultShippingAddressAction

of

static BusinessUnitSetDefaultShippingAddressAction of(BusinessUnitSetDefaultShippingAddressAction template)

factory method to create a shallow copy BusinessUnitSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitSetDefaultShippingAddressAction deepCopy(@Nullable
 BusinessUnitSetDefaultShippingAddressAction template)

factory method to create a deep copy of BusinessUnitSetDefaultShippingAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitSetDefaultShippingAddressActionBuilder builder()

builder factory method for BusinessUnitSetDefaultShippingAddressAction

Returns:

builder

builder

static BusinessUnitSetDefaultShippingAddressActionBuilder builder(BusinessUnitSetDefaultShippingAddressAction template)

create builder for BusinessUnitSetDefaultShippingAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitSetDefaultShippingAddressAction

default <T> T withBusinessUnitSetDefaultShippingAddressAction(Function<BusinessUnitSetDefaultShippingAddressAction,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<BusinessUnitSetDefaultShippingAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference