Package com.commercetools.api.models.business_unit

Interface BusinessUnitChangeAddressAction

All Superinterfaces:

BusinessUnitUpdateAction, ResourceUpdateAction<BusinessUnitUpdateAction>

All Known Implementing Classes:

BusinessUnitChangeAddressActionImpl

public interface BusinessUnitChangeAddressAction
extends BusinessUnitUpdateAction

Changing the address on a Business Unit generates the BusinessUnitAddressChanged Message.

Example to create an instance using the builder pattern

     BusinessUnitChangeAddressAction businessUnitChangeAddressAction = BusinessUnitChangeAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHANGE_ADDRESS	discriminator value for BusinessUnitChangeAddressAction

Method Summary

Modifier and Type	Method	Description
static BusinessUnitChangeAddressActionBuilder	builder()	builder factory method for BusinessUnitChangeAddressAction
static BusinessUnitChangeAddressActionBuilder	builder(BusinessUnitChangeAddressAction template)	create builder for BusinessUnitChangeAddressAction instance
static BusinessUnitChangeAddressAction	deepCopy(BusinessUnitChangeAddressAction template)	factory method to create a deep copy of BusinessUnitChangeAddressAction
@NotNull @Valid BaseAddress	getAddress()	New address to set.
String	getAddressId()	ID of the address to change.
String	getAddressKey()	Key of the address to change.
static BusinessUnitChangeAddressAction	of()	factory method
static BusinessUnitChangeAddressAction	of(BusinessUnitChangeAddressAction template)	factory method to create a shallow copy BusinessUnitChangeAddressAction
void	setAddress(BaseAddress address)	New address to set.
void	setAddressId(String addressId)	ID of the address to change.
void	setAddressKey(String addressKey)	Key of the address to change.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitChangeAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitChangeAddressAction(Function<BusinessUnitChangeAddressAction,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

CHANGE_ADDRESS

static final String CHANGE_ADDRESS

discriminator value for BusinessUnitChangeAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

ID of the address to change. Either addressId or addressKey is required.

Returns:

addressId

getAddressKey

String getAddressKey()

Key of the address to change. Either addressId or addressKey is required.

Returns:

addressKey

getAddress

@NotNull
@Valid
@NotNull @Valid BaseAddress getAddress()

New address to set.

Returns:

address

setAddressId

void setAddressId(String addressId)

ID of the address to change. Either addressId or addressKey is required.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

Key of the address to change. Either addressId or addressKey is required.

Parameters:

addressKey - value to be set

setAddress

void setAddress(BaseAddress address)

New address to set.

Parameters:

address - value to be set

of

static BusinessUnitChangeAddressAction of()

factory method

Returns:

instance of BusinessUnitChangeAddressAction

of

static BusinessUnitChangeAddressAction of(BusinessUnitChangeAddressAction template)

factory method to create a shallow copy BusinessUnitChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitChangeAddressAction deepCopy(@Nullable
 BusinessUnitChangeAddressAction template)

factory method to create a deep copy of BusinessUnitChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitChangeAddressActionBuilder builder()

builder factory method for BusinessUnitChangeAddressAction

Returns:

builder

builder

static BusinessUnitChangeAddressActionBuilder builder(BusinessUnitChangeAddressAction template)

create builder for BusinessUnitChangeAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitChangeAddressAction

default <T> T withBusinessUnitChangeAddressAction(Function<BusinessUnitChangeAddressAction,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<BusinessUnitChangeAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference