com.commercetools.api.models.discount_code

Interface DiscountCode

All Superinterfaces:

BaseResource, DomainResource<DiscountCode>

All Known Implementing Classes:

DiscountCodeImpl

public interface DiscountCode
extends BaseResource, DomainResource<DiscountCode>

Method Summary

Modifier and Type	Method and Description
static DiscountCodeBuilder	builder()
static DiscountCodeBuilder	builder(DiscountCode template)
@NotNull @Valid List<CartDiscountReference>	getCartDiscounts() The referenced matching cart discounts can be applied to the cart once the DiscountCode is added.
String	getCartPredicate() The discount code can only be applied to carts that match this predicate.
@NotNull String	getCode() Unique identifier of this discount code.
@NotNull ZonedDateTime	getCreatedAt()
@Valid CreatedBy	getCreatedBy() Present on resources created after 1/02/2019 except for events not tracked.
@Valid CustomFields	getCustom()
@Valid LocalizedString	getDescription()
@NotNull List<String>	getGroups() The groups to which this discount code belong.
@NotNull String	getId() The unique ID of the discount code.
@NotNull Boolean	getIsActive()
@NotNull ZonedDateTime	getLastModifiedAt()
@Valid LastModifiedBy	getLastModifiedBy() Present on resources updated after 1/02/2019 except for events not tracked.
Long	getMaxApplications() The discount code can only be applied maxApplications times.
Long	getMaxApplicationsPerCustomer() The discount code can only be applied maxApplicationsPerCustomer times per customer.
@Valid LocalizedString	getName()
@NotNull @Valid List<Reference>	getReferences() The platform will generate this array from the cart predicate.
ZonedDateTime	getValidFrom() The time from which the discount can be applied on a cart.
ZonedDateTime	getValidUntil() The time until the discount can be applied on a cart.
@NotNull Long	getVersion()
static DiscountCode	of()
static DiscountCode	of(DiscountCode template)
void	setCartDiscounts(CartDiscountReference... cartDiscounts)
void	setCartDiscounts(List<CartDiscountReference> cartDiscounts)
void	setCartPredicate(String cartPredicate)
void	setCode(String code)
void	setCreatedAt(ZonedDateTime createdAt)
void	setCreatedBy(CreatedBy createdBy)
void	setCustom(CustomFields custom)
void	setDescription(LocalizedString description)
void	setGroups(List<String> groups)
void	setGroups(String... groups)
void	setId(String id)
void	setIsActive(Boolean isActive)
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)
void	setLastModifiedBy(LastModifiedBy lastModifiedBy)
void	setMaxApplications(Long maxApplications)
void	setMaxApplicationsPerCustomer(Long maxApplicationsPerCustomer)
void	setName(LocalizedString name)
void	setReferences(List<Reference> references)
void	setReferences(Reference... references)
void	setValidFrom(ZonedDateTime validFrom)
void	setValidUntil(ZonedDateTime validUntil)
void	setVersion(Long version)
default <T> T	withDiscountCode(Function<DiscountCode,T> helper)

Methods inherited from interface com.commercetools.api.models.common.BaseResource

withBaseResource

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

get

Method Detail

getId

@NotNull
@NotNull String getId()

The unique ID of the discount code.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<DiscountCode>

getVersion

@NotNull
@NotNull Long getVersion()

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<DiscountCode>

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface BaseResource

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Specified by:

getLastModifiedAt in interface BaseResource

getLastModifiedBy

@Valid
@Valid LastModifiedBy getLastModifiedBy()

Present on resources updated after 1/02/2019 except for events not tracked.

getCreatedBy

@Valid
@Valid CreatedBy getCreatedBy()

Present on resources created after 1/02/2019 except for events not tracked.

getName

@Valid
@Valid LocalizedString getName()

getDescription

@Valid
@Valid LocalizedString getDescription()

getCode

@NotNull
@NotNull String getCode()

Unique identifier of this discount code. This value is added to the cart to enable the related cart discounts in the cart.

getCartDiscounts

@NotNull
 @Valid
@NotNull @Valid List<CartDiscountReference> getCartDiscounts()

The referenced matching cart discounts can be applied to the cart once the DiscountCode is added.

getCartPredicate

String getCartPredicate()

The discount code can only be applied to carts that match this predicate.

getIsActive

@NotNull
@NotNull Boolean getIsActive()

getReferences

@NotNull
 @Valid
@NotNull @Valid List<Reference> getReferences()

The platform will generate this array from the cart predicate. It contains the references of all the resources that are addressed in the predicate.

getMaxApplications

Long getMaxApplications()

The discount code can only be applied maxApplications times.

getMaxApplicationsPerCustomer

Long getMaxApplicationsPerCustomer()

The discount code can only be applied maxApplicationsPerCustomer times per customer.

getCustom

@Valid
@Valid CustomFields getCustom()

getGroups

@NotNull
@NotNull List<String> getGroups()

The groups to which this discount code belong.

getValidFrom

ZonedDateTime getValidFrom()

The time from which the discount can be applied on a cart. Before that time the code is invalid.

getValidUntil

ZonedDateTime getValidUntil()

The time until the discount can be applied on a cart. After that time the code is invalid.

setId

void setId(String id)

Specified by:

setId in interface BaseResource

setVersion

void setVersion(Long version)

Specified by:

setVersion in interface BaseResource

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

Specified by:

setCreatedAt in interface BaseResource

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Specified by:

setLastModifiedAt in interface BaseResource

setLastModifiedBy

void setLastModifiedBy(LastModifiedBy lastModifiedBy)

setCreatedBy

void setCreatedBy(CreatedBy createdBy)

setName

void setName(LocalizedString name)

setDescription

void setDescription(LocalizedString description)

setCode

void setCode(String code)

setCartDiscounts

void setCartDiscounts(CartDiscountReference... cartDiscounts)

setCartDiscounts

void setCartDiscounts(List<CartDiscountReference> cartDiscounts)

setCartPredicate

void setCartPredicate(String cartPredicate)

setIsActive

void setIsActive(Boolean isActive)

setReferences

void setReferences(Reference... references)

setReferences

void setReferences(List<Reference> references)

setMaxApplications

void setMaxApplications(Long maxApplications)

setMaxApplicationsPerCustomer

void setMaxApplicationsPerCustomer(Long maxApplicationsPerCustomer)

setCustom

void setCustom(CustomFields custom)

setGroups

void setGroups(String... groups)

setGroups

void setGroups(List<String> groups)

setValidFrom

void setValidFrom(ZonedDateTime validFrom)

setValidUntil

void setValidUntil(ZonedDateTime validUntil)

of

static DiscountCode of()

of

static DiscountCode of(DiscountCode template)

builder

static DiscountCodeBuilder builder()

builder

static DiscountCodeBuilder builder(DiscountCode template)

withDiscountCode

default <T> T withDiscountCode(Function<DiscountCode,T> helper)