io.sphere.sdk.products

Interface Product

All Superinterfaces:

CreationTimestamped, Identifiable<Product>, ProductIdentifiable, ProductLike<Product,Product>, Referenceable<Product>, Resource<Product>, ResourceIdentifiable<Product>, ResourceView<Product,Product>, Timestamped, Versioned<Product>, WithKey

public interface Product
extends ProductLike<Product,Product>, Resource<Product>

A sellable good.

Consider to use ProductProjection for queries if you don't need the whole product data so you can safe traffic and memory.

See Also:

ProductCreateCommand, ProductUpdateCommand, ProductDeleteCommand, ProductQuery, ProductByIdGet, ProductByKeyGet, ProductProjection, Category, ProductType, ProductDiscount, ProductDiscount.getReferences(), DiscountedPrice, Review.getTarget()

Method Summary

Modifier and Type	Method and Description
ProductCatalogData	getMasterData()
ReviewRatingStatistics	getReviewRatingStatistics()
Reference<State>	getState() Returns this state of this Product.
static Reference<Product>	reference(Product product)
static Reference<Product>	reference(String id)
static Reference<Product>	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 ProductProjection	toProjection(ProductProjectionType productProjectionType)
default Reference<Product>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Product>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.products.ProductLike

getKey, getProductType, getTaxCategory

Methods inherited from interface io.sphere.sdk.products.ProductIdentifiable

getId

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

getMasterData

ProductCatalogData getMasterData()

getState

@Nullable
Reference<State> getState()

Returns this state of this Product.

Specified by:

getState in interface ProductLike<Product,Product>

Returns:

state of this product or null

See Also:

TransitionState

typeReference

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

toReference

default Reference<Product> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<Product>

Specified by:

toReference in interface Resource<Product>

Returns:

reference

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

reference

static Reference<Product> reference(Product product)

reference

static Reference<Product> reference(String id)

toProjection

@Nullable
default ProductProjection toProjection(ProductProjectionType productProjectionType)

referenceOfId

static Reference<Product> 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

getReviewRatingStatistics

@Nullable
ReviewRatingStatistics getReviewRatingStatistics()

Specified by:

getReviewRatingStatistics in interface ProductLike<Product,Product>