io.sphere.sdk.productdiscounts

Interface ProductDiscount

All Superinterfaces:

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

public interface ProductDiscount
extends Resource<ProductDiscount>, WithKey

Product discounts are used to change certain product prices.

See Also:

ProductDiscountCreateCommand, ProductDiscountUpdateCommand, ProductDiscountDeleteCommand, ProductDiscountQuery, ProductDiscountByIdGet

Method Summary

Modifier and Type	Method and Description
LocalizedString	getDescription()
String	getKey()
LocalizedString	getName()
String	getPredicate()
List<Reference<com.fasterxml.jackson.databind.JsonNode>>	getReferences()
String	getSortOrder()
ZonedDateTime	getValidFrom()
ZonedDateTime	getValidUntil()
ProductDiscountValue	getValue()
Boolean	isActive()
static Reference<ProductDiscount>	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<ProductDiscount>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<ProductDiscount>	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

getKey

@Nullable
String getKey()

Specified by:

getKey in interface WithKey

getName

LocalizedString getName()

getDescription

@Nullable
LocalizedString getDescription()

getValue

ProductDiscountValue getValue()

getPredicate

String getPredicate()

getSortOrder

String getSortOrder()

isActive

Boolean isActive()

getValidFrom

@Nullable
ZonedDateTime getValidFrom()

getValidUntil

@Nullable
ZonedDateTime getValidUntil()

getReferences

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

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()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<ProductDiscount> 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<ProductDiscount> 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

toReference

default Reference<ProductDiscount> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<ProductDiscount>

Specified by:

toReference in interface Resource<ProductDiscount>

Returns:

reference