io.sphere.sdk.products

Interface ProductData

public interface ProductData

Method Summary

Modifier and Type	Method and Description
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()
ProductVariant	getMasterVariant() Returns the master variant.
LocalizedString	getMetaDescription()
LocalizedString	getMetaKeywords()
LocalizedString	getMetaTitle()
LocalizedString	getName()
SearchKeywords	getSearchKeywords()
LocalizedString	getSlug()
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.

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

metaAttributesOf, metaAttributesOf

Method Detail

getName

LocalizedString getName()

getCategories

Set<Reference<Category>> getCategories()

getDescription

@Nullable
LocalizedString getDescription()

getSlug

LocalizedString getSlug()

getMetaTitle

@Nullable
LocalizedString getMetaTitle()

getMetaDescription

@Nullable
LocalizedString getMetaDescription()

getMetaKeywords

@Nullable
LocalizedString getMetaKeywords()

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

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

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