io.sphere.sdk.cartdiscounts

Interface CartDiscount

All Superinterfaces:

CreationTimestamped, Custom, Identifiable<CartDiscount>, Referenceable<CartDiscount>, Resource<CartDiscount>, ResourceIdentifiable<CartDiscount>, ResourceView<CartDiscount,CartDiscount>, Timestamped, Versioned<CartDiscount>, WithKey

public interface CartDiscount
extends Resource<CartDiscount>, Custom, WithKey

Cart discounts are used to change the prices of different elements within a cart like Line Items.

See Also:

CartDiscountCreateCommand, CartDiscountUpdateCommand, CartDiscountDeleteCommand, CartDiscountQuery, CartDiscountByIdGet, DiscountCode.getCartDiscounts()

Method Summary

Modifier and Type	Method and Description
String	getCartPredicate() Predicate where the discounts should be applied to.
CustomFields	getCustom() Allow to add CustomFields to the CartDiscount
LocalizedString	getDescription() Description of this cart discount.
String	getKey()
LocalizedString	getName() Name of this discount.
List<Reference<com.fasterxml.jackson.databind.JsonNode>>	getReferences()
String	getSortOrder() Determinates the order of multiple cart discounts.
StackingMode	getStackingMode() Specify whether the application of this discount causes the following discounts to be ignored.
CartDiscountTarget	getTarget() Defines what part of the cart will be discounted.
ZonedDateTime	getValidFrom() Lower bound of the validity period.
ZonedDateTime	getValidUntil() Upper bound of the validity period.
CartDiscountValue	getValue() The value of the discount (determines the reduced price).
Boolean	isActive() Flag if the discount is active.
Boolean	isRequiringDiscountCode() States whether the the discount code can only be used in a connection with a DiscountCode.
static Reference<CartDiscount>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId()
default Reference<CartDiscount>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<CartDiscount>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getCartPredicate

String getCartPredicate()

Predicate where the discounts should be applied to.

Returns:

predicate

See Also:

isRequiringDiscountCode(), CartPredicate

getDescription

@Nullable
LocalizedString getDescription()

Description of this cart discount.

Returns:

description or null

See Also:

SetDescription

isActive

Boolean isActive()

Flag if the discount is active.

Returns:

true if active

See Also:

ChangeIsActive

getName

LocalizedString getName()

Name of this discount.

Returns:

name

See Also:

ChangeName

getReferences

List<Reference<com.fasterxml.jackson.databind.JsonNode>> getReferences()

isRequiringDiscountCode

Boolean isRequiringDiscountCode()

States whether the the discount code can only be used in a connection with a DiscountCode.

Returns:

true if requires a discount code

See Also:

ChangeRequiresDiscountCode

getSortOrder

String getSortOrder()

Determinates the order of multiple cart discounts. The string must contain a number between 0 and 1. All matching cart discounts are applied to a cart in the order defined by this field. The sortOrder must be unambiguous among all cart discounts.

Returns:

sort order

See Also:

ChangeSortOrder

getTarget

@Nullable
CartDiscountTarget getTarget()

Defines what part of the cart will be discounted.

Returns:

the target or null if getValue() is a GiftLineItemCartDiscountValue

See Also:

ChangeTarget

getCustom

@Nullable
CustomFields getCustom()

Allow to add CustomFields to the CartDiscount

Specified by:

getCustom in interface Custom

Returns:

the CustomFields defined at this CartDiscount

getValidFrom

@Nullable
ZonedDateTime getValidFrom()

Lower bound of the validity period.

Returns:

valid from date or null

See Also:

SetValidFrom

getValidUntil

@Nullable
ZonedDateTime getValidUntil()

Upper bound of the validity period.

Returns:

valid to date or null

See Also:

SetValidUntil

getValue

CartDiscountValue getValue()

The value of the discount (determines the reduced price).

Returns:

value

See Also:

ChangeValue

getStackingMode

StackingMode getStackingMode()

Specify whether the application of this discount causes the following discounts to be ignored. Defaults to StackingMode.STACKING.

Returns:

the stacking mode of this object

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

resourceTypeId

static String resourceTypeId()

toReference

default Reference<CartDiscount> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<CartDiscount>

Specified by:

toReference in interface Resource<CartDiscount>

Returns:

reference

typeReference

static com.fasterxml.jackson.core.type.TypeReference<CartDiscount> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceOfId

static Reference<CartDiscount> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference