Package com.commercetools.api.models.customer

Interface CustomerChangeAddressAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

All Known Implementing Classes:

CustomerChangeAddressActionImpl

public interface CustomerChangeAddressAction
extends CustomerUpdateAction

Changing an address of the Customer produces the CustomerAddressChanged Message.

Either addressId or addressKey is required.

Example to create an instance using the builder pattern

     CustomerChangeAddressAction customerChangeAddressAction = CustomerChangeAddressAction.builder()
             .address(addressBuilder -> addressBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static CustomerChangeAddressActionBuilder	builder()	builder factory method for CustomerChangeAddressAction
static CustomerChangeAddressActionBuilder	builder(CustomerChangeAddressAction template)	create builder for CustomerChangeAddressAction instance
static CustomerChangeAddressAction	deepCopy(CustomerChangeAddressAction template)	factory method to create a deep copy of CustomerChangeAddressAction
@NotNull @Valid BaseAddress	getAddress()	Value to set.
String	getAddressId()	id of the Address to change.
String	getAddressKey()	key of the Address to change.
static CustomerChangeAddressAction	of()	factory method
static CustomerChangeAddressAction	of(CustomerChangeAddressAction template)	factory method to create a shallow copy CustomerChangeAddressAction
void	setAddress(BaseAddress address)	Value 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<CustomerChangeAddressAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerChangeAddressAction(Function<CustomerChangeAddressAction,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

CHANGE_ADDRESS

static final String CHANGE_ADDRESS

discriminator value for CustomerChangeAddressAction

See Also:

• Constant Field Values

Method Details

getAddressId

String getAddressId()

id of the Address to change.

Returns:

addressId

getAddressKey

String getAddressKey()

key of the Address to change.

Returns:

addressKey

getAddress

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

Value to set.

Returns:

address

setAddressId

void setAddressId(String addressId)

id of the Address to change.

Parameters:

addressId - value to be set

setAddressKey

void setAddressKey(String addressKey)

key of the Address to change.

Parameters:

addressKey - value to be set

setAddress

void setAddress(BaseAddress address)

Value to set.

Parameters:

address - value to be set

of

static CustomerChangeAddressAction of()

factory method

Returns:

instance of CustomerChangeAddressAction

of

static CustomerChangeAddressAction of(CustomerChangeAddressAction template)

factory method to create a shallow copy CustomerChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CustomerChangeAddressAction deepCopy(@Nullable
 CustomerChangeAddressAction template)

factory method to create a deep copy of CustomerChangeAddressAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerChangeAddressActionBuilder builder()

builder factory method for CustomerChangeAddressAction

Returns:

builder

builder

static CustomerChangeAddressActionBuilder builder(CustomerChangeAddressAction template)

create builder for CustomerChangeAddressAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerChangeAddressAction

default <T> T withCustomerChangeAddressAction(Function<CustomerChangeAddressAction,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<CustomerChangeAddressAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference