Package com.commercetools.api.models.product

Interface ProductDataLike

All Superinterfaces:

MetaAttributes, WithLocalizedSlug

All Known Subinterfaces:

ProductData, ProductProjection, ProductProjectionMixin

public interface ProductDataLike
extends WithLocalizedSlug, MetaAttributes

Interface to describe commonalities between differen product representations

Method Summary

Modifier and Type	Method	Description
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.
List<CategoryReference>	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(long variantId)	Finds a product variant by id.
default ProductVariant	getVariantOrMaster(long 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.

Method Details

getName

LocalizedString getName()

getCategories

List<CategoryReference> getCategories()

getDescription

@Nullable
LocalizedString getDescription()

getSlug

LocalizedString getSlug()

Specified by:

getSlug in interface WithLocalizedSlug

getMetaTitle

@Nullable
LocalizedString getMetaTitle()

Specified by:

getMetaTitle in interface MetaAttributes

getMetaDescription

@Nullable
LocalizedString getMetaDescription()

Specified by:

getMetaDescription in interface MetaAttributes

getMetaKeywords

@Nullable
LocalizedString getMetaKeywords()

Specified by:

getMetaKeywords in interface MetaAttributes

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

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

getVariantOrMaster

default ProductVariant getVariantOrMaster(long 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

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

getSearchKeywords

SearchKeywords getSearchKeywords()

getCategoryOrderHints

@Nullable
CategoryOrderHints getCategoryOrderHints()