Package com.commercetools.api.models.product

Class ProductDataImpl

java.lang.Object

com.commercetools.api.models.product.ProductDataImpl

All Implemented Interfaces:

MetaAttributes, WithLocalizedSlug, ProductData, ProductDataLike, io.vrap.rmf.base.client.ModelBase

public class ProductDataImpl
extends Object
implements ProductData, io.vrap.rmf.base.client.ModelBase

Contains all the data of a Product and its Product Variants.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Constructor Summary

Constructors

Constructor	Description
ProductDataImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
List<CategoryReference>	getCategories()	Categories assigned to the Product.
CategoryOrderHints	getCategoryOrderHints()	Numerical values to allow ordering of Products within a specified Category.
LocalizedString	getDescription()	Description of the Product.
ProductVariant	getMasterVariant()	The Master Variant of the Product.
LocalizedString	getMetaDescription()	Description of the Product displayed in search results below the meta title.
LocalizedString	getMetaKeywords()	Keywords that give additional information about the Product to search engines.
LocalizedString	getMetaTitle()	Title of the Product displayed in search results.
LocalizedString	getName()	Name of the Product.
SearchKeywords	getSearchKeywords()	Used by Product Suggestions, but is also considered for a full text search.
LocalizedString	getSlug()	User-defined identifier used in a deep-link URL for the Product.
List<ProductVariant>	getVariants()	Additional Product Variants.
int	hashCode()
void	setCategories(CategoryReference... categories)	Categories assigned to the Product.
void	setCategories(List<CategoryReference> categories)	Categories assigned to the Product.
void	setCategoryOrderHints(CategoryOrderHints categoryOrderHints)	Numerical values to allow ordering of Products within a specified Category.
void	setDescription(LocalizedString description)	Description of the Product.
void	setMasterVariant(ProductVariant masterVariant)	The Master Variant of the Product.
void	setMetaDescription(LocalizedString metaDescription)	Description of the Product displayed in search results below the meta title.
void	setMetaKeywords(LocalizedString metaKeywords)	Keywords that give additional information about the Product to search engines.
void	setMetaTitle(LocalizedString metaTitle)	Title of the Product displayed in search results.
void	setName(LocalizedString name)	Name of the Product.
void	setSearchKeywords(SearchKeywords searchKeywords)	Used by Product Suggestions, but is also considered for a full text search.
void	setSlug(LocalizedString slug)	User-defined identifier used in a deep-link URL for the Product.
void	setVariants(ProductVariant... variants)	Additional Product Variants.
void	setVariants(List<ProductVariant> variants)	Additional Product Variants.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Methods inherited from interface com.commercetools.api.models.product.ProductData

withProductData

Methods inherited from interface com.commercetools.api.models.product.ProductDataLike

findVariantBySku, getAllVariants, getVariant, getVariantOrMaster

Constructor Details

ProductDataImpl

public ProductDataImpl()

create empty instance

Method Details

getName

public LocalizedString getName()

Name of the Product.

Specified by:

getName in interface ProductData

Specified by:

getName in interface ProductDataLike

Returns:

name

getCategories

public List<CategoryReference> getCategories()

Categories assigned to the Product.

Specified by:

getCategories in interface ProductData

Specified by:

getCategories in interface ProductDataLike

Returns:

categories

getCategoryOrderHints

public CategoryOrderHints getCategoryOrderHints()

Numerical values to allow ordering of Products within a specified Category.

Specified by:

getCategoryOrderHints in interface ProductData

Specified by:

getCategoryOrderHints in interface ProductDataLike

Returns:

categoryOrderHints

getDescription

public LocalizedString getDescription()

Description of the Product.

Specified by:

getDescription in interface ProductData

Specified by:

getDescription in interface ProductDataLike

Returns:

description

getSlug

public LocalizedString getSlug()

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

Specified by:

getSlug in interface ProductData

Specified by:

getSlug in interface ProductDataLike

Specified by:

getSlug in interface WithLocalizedSlug

Returns:

slug

getMetaTitle

public LocalizedString getMetaTitle()

Title of the Product displayed in search results.

Specified by:

getMetaTitle in interface MetaAttributes

Specified by:

getMetaTitle in interface ProductData

Specified by:

getMetaTitle in interface ProductDataLike

Returns:

metaTitle

getMetaDescription

public LocalizedString getMetaDescription()

Description of the Product displayed in search results below the meta title.

Specified by:

getMetaDescription in interface MetaAttributes

Specified by:

getMetaDescription in interface ProductData

Specified by:

getMetaDescription in interface ProductDataLike

Returns:

metaDescription

getMetaKeywords

public LocalizedString getMetaKeywords()

Keywords that give additional information about the Product to search engines.

Specified by:

getMetaKeywords in interface MetaAttributes

Specified by:

getMetaKeywords in interface ProductData

Specified by:

getMetaKeywords in interface ProductDataLike

Returns:

metaKeywords

getMasterVariant

public ProductVariant getMasterVariant()

The Master Variant of the Product.

Specified by:

getMasterVariant in interface ProductData

Specified by:

getMasterVariant in interface ProductDataLike

Returns:

masterVariant

See Also:

• ProductDataLike.getAllVariants()
• ProductDataLike.getVariants()

getVariants

public List<ProductVariant> getVariants()

Additional Product Variants.

Specified by:

getVariants in interface ProductData

Specified by:

getVariants in interface ProductDataLike

Returns:

variants

See Also:

• ProductDataLike.getAllVariants()
• ProductDataLike.getMasterVariant()

getSearchKeywords

public SearchKeywords getSearchKeywords()

Used by Product Suggestions, but is also considered for a full text search.

Specified by:

getSearchKeywords in interface ProductData

Specified by:

getSearchKeywords in interface ProductDataLike

Returns:

searchKeywords

setName

public void setName(LocalizedString name)

Description copied from interface: ProductData

Name of the Product.

Specified by:

setName in interface ProductData

Parameters:

name - value to be set

setCategories

public void setCategories(CategoryReference... categories)

Description copied from interface: ProductData

Categories assigned to the Product.

Specified by:

setCategories in interface ProductData

Parameters:

categories - values to be set

setCategories

public void setCategories(List<CategoryReference> categories)

Description copied from interface: ProductData

Categories assigned to the Product.

Specified by:

setCategories in interface ProductData

Parameters:

categories - values to be set

setCategoryOrderHints

public void setCategoryOrderHints(CategoryOrderHints categoryOrderHints)

Description copied from interface: ProductData

Numerical values to allow ordering of Products within a specified Category.

Specified by:

setCategoryOrderHints in interface ProductData

Parameters:

categoryOrderHints - value to be set

setDescription

public void setDescription(LocalizedString description)

Description copied from interface: ProductData

Description of the Product.

Specified by:

setDescription in interface ProductData

Parameters:

description - value to be set

setSlug

public void setSlug(LocalizedString slug)

Description copied from interface: ProductData

User-defined identifier used in a deep-link URL for the Product. Must be unique across a Project, but can be the same for Products in different Locales. Matches the pattern [a-zA-Z0-9_\\-]{2,256}.

Specified by:

setSlug in interface ProductData

Parameters:

slug - value to be set

setMetaTitle

public void setMetaTitle(LocalizedString metaTitle)

Description copied from interface: ProductData

Title of the Product displayed in search results.

Specified by:

setMetaTitle in interface ProductData

Parameters:

metaTitle - value to be set

setMetaDescription

public void setMetaDescription(LocalizedString metaDescription)

Description copied from interface: ProductData

Description of the Product displayed in search results below the meta title.

Specified by:

setMetaDescription in interface ProductData

Parameters:

metaDescription - value to be set

setMetaKeywords

public void setMetaKeywords(LocalizedString metaKeywords)

Description copied from interface: ProductData

Keywords that give additional information about the Product to search engines.

Specified by:

setMetaKeywords in interface ProductData

Parameters:

metaKeywords - value to be set

setMasterVariant

public void setMasterVariant(ProductVariant masterVariant)

Description copied from interface: ProductData

The Master Variant of the Product.

Specified by:

setMasterVariant in interface ProductData

Parameters:

masterVariant - value to be set

setVariants

public void setVariants(ProductVariant... variants)

Description copied from interface: ProductData

Additional Product Variants.

Specified by:

setVariants in interface ProductData

Parameters:

variants - values to be set

setVariants

public void setVariants(List<ProductVariant> variants)

Description copied from interface: ProductData

Additional Product Variants.

Specified by:

setVariants in interface ProductData

Parameters:

variants - values to be set

setSearchKeywords

public void setSearchKeywords(SearchKeywords searchKeywords)

Description copied from interface: ProductData

Used by Product Suggestions, but is also considered for a full text search.

Specified by:

setSearchKeywords in interface ProductData

Parameters:

searchKeywords - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object