Package com.commercetools.api.models.shipping_method

Interface ShippingMethodSetStoresAction

All Superinterfaces:

ResourceUpdateAction<ShippingMethodUpdateAction>, ShippingMethodUpdateAction

public interface ShippingMethodSetStoresAction
extends ShippingMethodUpdateAction

Sets the Stores the ShippingMethod is associated with. If empty, the ShippingMethod becomes a global ShippingMethod.

Example to create an instance using the builder pattern

     ShippingMethodSetStoresAction shippingMethodSetStoresAction = ShippingMethodSetStoresAction.builder()
             .plusStores(storesBuilder -> storesBuilder)
             .build()
 

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
static ShippingMethodSetStoresActionBuilder	builder()	builder factory method for ShippingMethodSetStoresAction
static ShippingMethodSetStoresActionBuilder	builder(ShippingMethodSetStoresAction template)	create builder for ShippingMethodSetStoresAction instance
ShippingMethodSetStoresAction	copyDeep()
static ShippingMethodSetStoresAction	deepCopy(ShippingMethodSetStoresAction template)	factory method to create a deep copy of ShippingMethodSetStoresAction
@NotNull @Valid List<StoreResourceIdentifier>	getStores()	ResourceIdentifiers of the Stores to set.
static ShippingMethodSetStoresAction	of()	factory method
static ShippingMethodSetStoresAction	of(ShippingMethodSetStoresAction template)	factory method to create a shallow copy ShippingMethodSetStoresAction
void	setStores(StoreResourceIdentifier... stores)	ResourceIdentifiers of the Stores to set.
void	setStores(List<StoreResourceIdentifier> stores)	ResourceIdentifiers of the Stores to set.
static tools.jackson.core.type.TypeReference<ShippingMethodSetStoresAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withShippingMethodSetStoresAction(Function<ShippingMethodSetStoresAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.ResourceUpdateAction

get

Methods inherited from interface com.commercetools.api.models.shipping_method.ShippingMethodUpdateAction

getAction, withShippingMethodUpdateAction

Field Details

SET_STORES

static final String SET_STORES

discriminator value for ShippingMethodSetStoresAction

See Also:

• Constant Field Values

Method Details

getStores

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

ResourceIdentifiers of the Stores to set. Overrides the current list of Stores. If empty, any existing values are removed.

Returns:

stores

setStores

void setStores(StoreResourceIdentifier... stores)

ResourceIdentifiers of the Stores to set. Overrides the current list of Stores. If empty, any existing values are removed.

Parameters:

stores - values to be set

setStores

void setStores(List<StoreResourceIdentifier> stores)

ResourceIdentifiers of the Stores to set. Overrides the current list of Stores. If empty, any existing values are removed.

Parameters:

stores - values to be set

of

static ShippingMethodSetStoresAction of()

factory method

Returns:

instance of ShippingMethodSetStoresAction

of

static ShippingMethodSetStoresAction of(ShippingMethodSetStoresAction template)

factory method to create a shallow copy ShippingMethodSetStoresAction

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

ShippingMethodSetStoresAction copyDeep()

Specified by:

copyDeep in interface ShippingMethodUpdateAction

deepCopy

@Nullable
static ShippingMethodSetStoresAction deepCopy(@Nullable
 ShippingMethodSetStoresAction template)

factory method to create a deep copy of ShippingMethodSetStoresAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static ShippingMethodSetStoresActionBuilder builder()

builder factory method for ShippingMethodSetStoresAction

Returns:

builder

builder

static ShippingMethodSetStoresActionBuilder builder(ShippingMethodSetStoresAction template)

create builder for ShippingMethodSetStoresAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withShippingMethodSetStoresAction

default <T> T withShippingMethodSetStoresAction(Function<ShippingMethodSetStoresAction,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static tools.jackson.core.type.TypeReference<ShippingMethodSetStoresAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference