Package com.commercetools.api.models.me

Interface MyBusinessUnitChangeAddressAction

All Superinterfaces:

MyBusinessUnitUpdateAction

All Known Implementing Classes:

MyBusinessUnitChangeAddressActionImpl

public interface MyBusinessUnitChangeAddressAction
extends MyBusinessUnitUpdateAction

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

Example to create an instance using the builder pattern

     MyBusinessUnitChangeAddressAction myBusinessUnitChangeAddressAction = MyBusinessUnitChangeAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static MyBusinessUnitChangeAddressActionBuilder	builder()	builder factory method for MyBusinessUnitChangeAddressAction
static MyBusinessUnitChangeAddressActionBuilder	builder(MyBusinessUnitChangeAddressAction template)	create builder for MyBusinessUnitChangeAddressAction instance
static MyBusinessUnitChangeAddressAction	deepCopy(MyBusinessUnitChangeAddressAction template)	factory method to create a deep copy of MyBusinessUnitChangeAddressAction
@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 MyBusinessUnitChangeAddressAction	of()	factory method
static MyBusinessUnitChangeAddressAction	of(MyBusinessUnitChangeAddressAction template)	factory method to create a shallow copy MyBusinessUnitChangeAddressAction
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<MyBusinessUnitChangeAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withMyBusinessUnitChangeAddressAction(Function<MyBusinessUnitChangeAddressAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.me.MyBusinessUnitUpdateAction

getAction, withMyBusinessUnitUpdateAction

Field Details

CHANGE_ADDRESS

static final String CHANGE_ADDRESS

discriminator value for MyBusinessUnitChangeAddressAction

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 MyBusinessUnitChangeAddressAction of()

factory method

Returns:

instance of MyBusinessUnitChangeAddressAction

of

static MyBusinessUnitChangeAddressAction of(MyBusinessUnitChangeAddressAction template)

factory method to create a shallow copy MyBusinessUnitChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static MyBusinessUnitChangeAddressAction deepCopy(@Nullable
 MyBusinessUnitChangeAddressAction template)

factory method to create a deep copy of MyBusinessUnitChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static MyBusinessUnitChangeAddressActionBuilder builder()

builder factory method for MyBusinessUnitChangeAddressAction

Returns:

builder

builder

static MyBusinessUnitChangeAddressActionBuilder builder(MyBusinessUnitChangeAddressAction template)

create builder for MyBusinessUnitChangeAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withMyBusinessUnitChangeAddressAction

default <T> T withMyBusinessUnitChangeAddressAction(Function<MyBusinessUnitChangeAddressAction,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<MyBusinessUnitChangeAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference