Package com.commercetools.api.models.customer

Interface CustomerSetStoresAction

All Superinterfaces:

CustomerUpdateAction, ResourceUpdateAction<CustomerUpdateAction>

public interface CustomerSetStoresAction
extends CustomerUpdateAction

Sets the Stores the Customer account is associated with. If no Stores are specified, the Customer becomes a global Customer.

This action generates the CustomerStoresSet Message.

Example to create an instance using the builder pattern

     CustomerSetStoresAction customerSetStoresAction = CustomerSetStoresAction.builder()
             .plusStores(storesBuilder -> storesBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SET_STORES	discriminator value for CustomerSetStoresAction

Method Summary

Modifier and Type	Method	Description
static CustomerSetStoresActionBuilder	builder()	builder factory method for CustomerSetStoresAction
static CustomerSetStoresActionBuilder	builder(CustomerSetStoresAction template)	create builder for CustomerSetStoresAction instance
CustomerSetStoresAction	copyDeep()
static CustomerSetStoresAction	deepCopy(CustomerSetStoresAction template)	factory method to create a deep copy of CustomerSetStoresAction
@NotNull @Valid List<StoreResourceIdentifier>	getStores()	ResourceIdentifier of the Stores to set.
static CustomerSetStoresAction	of()	factory method
static CustomerSetStoresAction	of(CustomerSetStoresAction template)	factory method to create a shallow copy CustomerSetStoresAction
void	setStores(StoreResourceIdentifier... stores)	ResourceIdentifier of the Stores to set.
void	setStores(List<StoreResourceIdentifier> stores)	ResourceIdentifier of the Stores to set.
static com.fasterxml.jackson.core.type.TypeReference<CustomerSetStoresAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCustomerSetStoresAction(Function<CustomerSetStoresAction,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_STORES

static final String SET_STORES

discriminator value for CustomerSetStoresAction

See Also:

• Constant Field Values

Method Details

getStores

@NotNull
@Valid
@NotNull @Valid List<StoreResourceIdentifier> getStores()

ResourceIdentifier of the Stores to set.

Returns:

stores

setStores

void setStores(StoreResourceIdentifier... stores)

ResourceIdentifier of the Stores to set.

Parameters:

stores - values to be set

setStores

void setStores(List<StoreResourceIdentifier> stores)

ResourceIdentifier of the Stores to set.

Parameters:

stores - values to be set

of

static CustomerSetStoresAction of()

factory method

Returns:

instance of CustomerSetStoresAction

of

static CustomerSetStoresAction of(CustomerSetStoresAction template)

factory method to create a shallow copy CustomerSetStoresAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

CustomerSetStoresAction copyDeep()

Specified by:

copyDeep in interface CustomerUpdateAction

deepCopy

@Nullable
static CustomerSetStoresAction deepCopy(@Nullable
 CustomerSetStoresAction template)

factory method to create a deep copy of CustomerSetStoresAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CustomerSetStoresActionBuilder builder()

builder factory method for CustomerSetStoresAction

Returns:

builder

builder

static CustomerSetStoresActionBuilder builder(CustomerSetStoresAction template)

create builder for CustomerSetStoresAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCustomerSetStoresAction

default <T> T withCustomerSetStoresAction(Function<CustomerSetStoresAction,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<CustomerSetStoresAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference