io.sphere.sdk.products

Interface ProductProjection

All Superinterfaces:

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

public interface ProductProjection
extends ProductLike<ProductProjection,Product>, Referenceable<Product>, Versioned<Product>

A projected representation of a product shows the product with its current or staged data. ProductProjections are views of Products.

To create, update or delete ProductProjections you have to use the Product lifecycle classes.

Operations:

• Fetch by ID with ProductProjectionByIdGet

If you need ProductProjection for a method but you have a product, you can transform a product into a product projection:

final Product product = getProduct();

final ProductProjection staged = product.toProjection(ProductProjectionType.STAGED);

assertThat(staged).overridingErrorMessage("staged is always present").isNotNull();
assertThat(staged.getName()).isEqualTo(product.getMasterData().getStaged().getName());

final ProductProjection current = product.toProjection(ProductProjectionType.CURRENT);
assertThat(current).overridingErrorMessage("current can be empty").isNull();
See the test code.

toReference() returns not are reference to a ProductProjection but to a Product.

Method Summary

Modifier and Type	Method and Description
default Optional<ProductVariant>	findFirstMatchingVariant() Finds the first matching variant according to the search criteria used in the search request, if any.
default List<ProductVariant>	findMatchingVariants() Finds all variants that match the search criteria used in the search request, if any.
default Optional<ProductVariant>	findVariant(ByIdVariantIdentifier identifier)
default Optional<ProductVariant>	findVariantBySku(String sku) Finds a variant by SKU.
default List<ProductVariant>	getAllVariants() Gets all variants in the product including the master variant as first element in the list.
Set<Reference<Category>>	getCategories()
CategoryOrderHints	getCategoryOrderHints()
LocalizedString	getDescription()
String	getKey() Key of the product.
ProductVariant	getMasterVariant() Returns the master variant.
LocalizedString	getMetaDescription()
LocalizedString	getMetaKeywords()
LocalizedString	getMetaTitle()
LocalizedString	getName()
ReviewRatingStatistics	getReviewRatingStatistics()
SearchKeywords	getSearchKeywords()
LocalizedString	getSlug()
Reference<State>	getState()
default ProductVariant	getVariant(int variantId) Finds a product variant by id.
default ProductVariant	getVariantOrMaster(int variantId) Finds a product variant by id and returns the master variant if not variant with the id is present.
List<ProductVariant>	getVariants() Gets the variants which are not identical to the master variant.
Boolean	hasStagedChanges()
Boolean	isPublished()
default Reference<Product>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<ProductProjection>	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

getProductType, getTaxCategory

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

getCreatedAt, getId, getLastModifiedAt, getVersion

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

of, of

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

getId

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

metaAttributesOf, metaAttributesOf

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

hasSameIdAs, toResourceIdentifier

Method Detail

hasStagedChanges

Boolean hasStagedChanges()

isPublished

Boolean isPublished()

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>

Returns:

reference

typeReference

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

getCategories

Set<Reference<Category>> getCategories()

getDescription

@Nullable
LocalizedString getDescription()

getMasterVariant

ProductVariant getMasterVariant()

Returns the master variant. Every product as 1 to n variants, so this is always present.

Returns:

the main variant in the product

See Also:

getAllVariants(), getVariants(), ChangeMasterVariant

getMetaDescription

@Nullable
LocalizedString getMetaDescription()

getMetaKeywords

@Nullable
LocalizedString getMetaKeywords()

getMetaTitle

@Nullable
LocalizedString getMetaTitle()

getName

LocalizedString getName()

getSlug

LocalizedString getSlug()

getVariants

List<ProductVariant> getVariants()

Gets the variants which are not identical to the master variant. This list can be empty.

Returns:

all variants except the one in getMasterVariant()

See Also:

getAllVariants(), getMasterVariant()

getAllVariants

default List<ProductVariant> getAllVariants()

Gets all variants in the product including the master variant as first element in the list.

Returns:

all variants

See Also:

getMasterVariant(), getVariants()

findVariant

default Optional<ProductVariant> findVariant(ByIdVariantIdentifier identifier)

findVariantBySku

default Optional<ProductVariant> findVariantBySku(String sku)

Finds a variant by SKU.

Parameters:

sku - the sku for the variant

Returns:

Optional of the found variant

findMatchingVariants

default List<ProductVariant> findMatchingVariants()

Finds all variants that match the search criteria used in the search request, if any.

Returns:

the list containing all matching variants

findFirstMatchingVariant

default Optional<ProductVariant> findFirstMatchingVariant()

Finds the first matching variant according to the search criteria used in the search request, if any.

Returns:

the first product variant that matches the search criteria, or empty if none does

getVariant

@Nullable
default ProductVariant getVariant(int variantId)

Finds a product variant by id.

Parameters:

variantId - the id of the variant to find

Returns:

variant or null if no variant exists with id

See Also:

getVariantOrMaster(int)

getVariantOrMaster

default ProductVariant getVariantOrMaster(int variantId)

Finds a product variant by id and returns the master variant if not variant with the id is present.

Parameters:

variantId - the id of the variant to find

Returns:

a variant

See Also:

getVariant(int)

getSearchKeywords

SearchKeywords getSearchKeywords()

getCategoryOrderHints

@Nullable
CategoryOrderHints getCategoryOrderHints()

getReviewRatingStatistics

@Nullable
ReviewRatingStatistics getReviewRatingStatistics()

Specified by:

getReviewRatingStatistics in interface ProductLike<ProductProjection,Product>

getState

@Nullable
Reference<State> getState()

Specified by:

getState in interface ProductLike<ProductProjection,Product>

getKey

@Nullable
String getKey()

Description copied from interface: ProductLike

Key of the product.

Specified by:

getKey in interface ProductLike<ProductProjection,Product>

Specified by:

getKey in interface WithKey

Returns:

key

See Also:

SetKey, ProductByKeyGet, ProductProjectionByKeyGet, ProductDeleteCommand.ofKey(String, Long), ProductUpdateCommand.ofKey(String, Long, List), ProductUpdateCommand.ofKey(String, Long, UpdateAction)