Package com.commercetools.api.models.cart_discount

Interface CartDiscountAddStoreAction

All Superinterfaces:

CartDiscountUpdateAction, ResourceUpdateAction<CartDiscountUpdateAction>

All Known Implementing Classes:

CartDiscountAddStoreActionImpl

public interface CartDiscountAddStoreAction
extends CartDiscountUpdateAction

If a referenced Store does not exist, a ReferencedResourceNotFound error is returned.

Example to create an instance using the builder pattern

     CartDiscountAddStoreAction cartDiscountAddStoreAction = CartDiscountAddStoreAction.builder()
             .store(storeBuilder -> storeBuilder)
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_STORE	discriminator value for CartDiscountAddStoreAction

Method Summary

Modifier and Type	Method	Description
static CartDiscountAddStoreActionBuilder	builder()	builder factory method for CartDiscountAddStoreAction
static CartDiscountAddStoreActionBuilder	builder(CartDiscountAddStoreAction template)	create builder for CartDiscountAddStoreAction instance
static CartDiscountAddStoreAction	deepCopy(CartDiscountAddStoreAction template)	factory method to create a deep copy of CartDiscountAddStoreAction
@NotNull @Valid StoreResourceIdentifier	getStore()	Store to add.
static CartDiscountAddStoreAction	of()	factory method
static CartDiscountAddStoreAction	of(CartDiscountAddStoreAction template)	factory method to create a shallow copy CartDiscountAddStoreAction
void	setStore(StoreResourceIdentifier store)	Store to add.
static com.fasterxml.jackson.core.type.TypeReference<CartDiscountAddStoreAction>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withCartDiscountAddStoreAction(Function<CartDiscountAddStoreAction,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.cart_discount.CartDiscountUpdateAction

getAction, withCartDiscountUpdateAction

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

get

Field Details

ADD_STORE

static final String ADD_STORE

discriminator value for CartDiscountAddStoreAction

See Also:

• Constant Field Values

Method Details

getStore

@NotNull
@Valid
@NotNull @Valid StoreResourceIdentifier getStore()

Store to add.

A failed update can return the following errors:

• If the referenced Stores exceed the limit, a MaxStoreReferencesReached error is returned.
• If the referenced Stores exceed the limit for Cart Discounts that do not require a Discount Code, a StoreCartDiscountsLimitReached error is returned.

Returns:

store

setStore

void setStore(StoreResourceIdentifier store)

Store to add.

A failed update can return the following errors:

• If the referenced Stores exceed the limit, a MaxStoreReferencesReached error is returned.
• If the referenced Stores exceed the limit for Cart Discounts that do not require a Discount Code, a StoreCartDiscountsLimitReached error is returned.

Parameters:

store - value to be set

of

static CartDiscountAddStoreAction of()

factory method

Returns:

instance of CartDiscountAddStoreAction

of

static CartDiscountAddStoreAction of(CartDiscountAddStoreAction template)

factory method to create a shallow copy CartDiscountAddStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static CartDiscountAddStoreAction deepCopy(@Nullable
 CartDiscountAddStoreAction template)

factory method to create a deep copy of CartDiscountAddStoreAction

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static CartDiscountAddStoreActionBuilder builder()

builder factory method for CartDiscountAddStoreAction

Returns:

builder

builder

static CartDiscountAddStoreActionBuilder builder(CartDiscountAddStoreAction template)

create builder for CartDiscountAddStoreAction instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withCartDiscountAddStoreAction

default <T> T withCartDiscountAddStoreAction(Function<CartDiscountAddStoreAction,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<CartDiscountAddStoreAction> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference