Class VariationGroup
Class representing a group of variants within a master product who share a
common value for one or more variation attribute values. Variation groups are
used to simplify merchandising of products.
From a more technical perspective, variation groups are defined by two things:
A relation to a master product.
A set of variation attributes which have fixed values.
A variant of the related master product is considered in the group if and
only if it matches on the fixed variation attribute values.
Similar to a Variant, a VariationGroup does a fallback to the master product
for all attributes (name, description, etc) and relations (recommendations,
etc).
Property Summary
Property Description EAN : String (read-only)Returns the EAN of the product variation group. UPC : String (read-only)Returns the UPC of the product variation group. allProductLinks : Collection (read-only)Returns all product links of the product variation group. brand : String (read-only)Returns the brand of the product variation group. classificationCategory : Category (read-only)Returns the classification category of the product variation group. custom : CustomAttributes (read-only)Returns the custom attributes of the variation group. image : MediaFile (read-only)Returns the image of the product variation group. longDescription : MarkupText (read-only)Returns the long description of the product variation group. manufacturerName : String (read-only)Returns the manufacturer name of the product variation group. manufacturerSKU : String (read-only)Returns the manufacturer sku of the product variation group. masterProduct : Product (read-only)Returns the ProductMaster for this mastered product. name : String (read-only)Returns the name of the product variation group. onlineFrom : Date (read-only)Returns the onlineFrom date of the product variation group. onlineTo : Date (read-only)Returns the onlineTo date of the product variation group. optionProduct : Boolean (read-only)Returns ‘true’ if the variation group has any options, otherwise ‘false’. pageDescription : String (read-only)Returns the pageDescription of the product variation group. pageKeywords : String (read-only)Returns the pageKeywords of the product variation group. pageTitle : String (read-only)Returns the pageTitle of the product variation group. pageURL : String (read-only)Returns the pageURL of the product variation group. productLinks : Collection (read-only)Returns all product links of the product variation group for which the target product is assigned to the current site catalog. shortDescription : MarkupText (read-only)Returns the short description of the product variation group. taxClassID : String (read-only)Returns the tax class id of the product variation group. template : String (read-only)Returns the rendering template name of the product variation group. thumbnail : MediaFile (read-only)Returns the thumbnail image of the product variation group. unit : String (read-only)Returns the sales unit of the product variation group as defined by the master product. unitQuantity : Quantity (read-only)Returns the unitQuantity of the product variation group as defined by the master product.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
Method Description getAllProductLinks ()Returns all product links of the product variation group. getAllProductLinks (Number )Returns all product links of the specified type of the product variation group. getBrand ()Returns the brand of the product variation group. getClassificationCategory ()Returns the classification category of the product variation group. getCustom ()Returns the custom attributes of the variation group. getEAN ()Returns the EAN of the product variation group. getImage ()Returns the image of the product variation group. getLongDescription ()Returns the long description of the product variation group. getManufacturerName ()Returns the manufacturer name of the product variation group. getManufacturerSKU ()Returns the manufacturer sku of the product variation group. getMasterProduct ()Returns the ProductMaster for this mastered product. getName ()Returns the name of the product variation group. getOnlineFrom ()Returns the onlineFrom date of the product variation group. getOnlineTo ()Returns the onlineTo date of the product variation group. getPageDescription ()Returns the pageDescription of the product variation group. getPageKeywords ()Returns the pageKeywords of the product variation group. getPageTitle ()Returns the pageTitle of the product variation group. getPageURL ()Returns the pageURL of the product variation group. getProductLinks ()Returns all product links of the product variation group for which the target product is assigned to the current site catalog. getProductLinks (Number )Returns all product links of the specified type of the product variation group for which the target product is assigned to the current site catalog. getRecommendations (Number )Retrieve the sorted collection of recommendations of the specified type for this product variation group. getShortDescription ()Returns the short description of the product variation group. getTaxClassID ()Returns the tax class id of the product variation group. getTemplate ()Returns the rendering template name of the product variation group. getThumbnail ()Returns the thumbnail image of the product variation group. getUPC ()Returns the UPC of the product variation group. getUnit ()Returns the sales unit of the product variation group as defined by the master product. getUnitQuantity ()Returns the unitQuantity of the product variation group as defined by the master product. isOptionProduct ()Returns ‘true’ if the variation group has any options, otherwise ‘false’.
Methods inherited from class Product
assignedToCategory , getActiveData , getAllCategories , getAllCategoryAssignments , getAllIncomingProductLinks , getAllIncomingProductLinks , getAllProductLinks , getAllProductLinks , getAllRecommendations , getAllRecommendations , getAttributeModel , getAvailabilityModel , getAvailabilityModel , getAvailableFlag , getBrand , getBundledProductQuantity , getBundledProducts , getBundles , getCategories , getCategoryAssignment , getCategoryAssignments , getClassificationCategory , getEAN , getID , getImage , getImage , getImage , getImages , getIncomingProductLinks , getIncomingProductLinks , getLongDescription , getManufacturerName , getManufacturerSKU , getMinOrderQuantity , getName , getOnlineCategories , getOnlineFlag , getOnlineFrom , getOnlineTo , getOptionModel , getOrderableRecommendations , getOrderableRecommendations , getPageDescription , getPageKeywords , getPageMetaTag , getPageMetaTags , getPageTitle , getPageURL , getPriceModel , getPriceModel , getPrimaryCategory , getPrimaryCategoryAssignment , getProductLinks , getProductLinks , getProductSetProducts , getProductSets , getRecommendations , getRecommendations , getSearchPlacement , getSearchRank , getSearchableFlag , getSearchableIfUnavailableFlag , getShortDescription , getSiteMapChangeFrequency , getSiteMapIncluded , getSiteMapPriority , getStepQuantity , getStoreReceiptName , getStoreTaxClass , getTaxClassID , getTemplate , getThumbnail , getUPC , getUnit , getUnitQuantity , getVariants , getVariationGroups , getVariationModel , includedInBundle , isAssignedToCategory , isAssignedToSiteCatalog , isAvailable , isBundle , isBundled , isCategorized , isFacebookEnabled , isMaster , isOnline , isOptionProduct , isPinterestEnabled , isProduct , isProductSet , isProductSetProduct , isRetailSet , isSearchable , isSiteProduct , isVariant , isVariationGroup , setAvailableFlag , setOnlineFlag , setOnlineFlag , setSearchPlacement , setSearchPlacement , setSearchRank , setSearchRank , setSearchableFlag , setSearchableFlag
Methods inherited from class ExtensibleObject
describe , getCustom
Methods inherited from class PersistentObject
getCreationDate , getLastModified , getUUID
Methods inherited from class Object
assign , create , create , defineProperties , defineProperty , entries , freeze , fromEntries , getOwnPropertyDescriptor , getOwnPropertyNames , getOwnPropertySymbols , getPrototypeOf , hasOwnProperty , is , isExtensible , isFrozen , isPrototypeOf , isSealed , keys , preventExtensions , propertyIsEnumerable , seal , setPrototypeOf , toLocaleString , toString , valueOf , values
Property Details
EAN
EAN: String (read-only)
Returns the EAN of the product variation group.
If the variation group does not define an own value for 'EAN', the value of
the master product is returned.
UPC
UPC: String (read-only)
Returns the UPC of the product variation group.
If the variation group does not define an own value for 'UPC', the value of
the master product is returned.
allProductLinks
allProductLinks: Collection (read-only)
Returns all product links of the product variation group.
If the variation group does not define any product links, but the master product
does, the product links of the master are returned.
brand
brand: String (read-only)
Returns the brand of the product variation group.
If the variation group does not define an own value for 'brand', the value of
the master product is returned.
classificationCategory
classificationCategory: Category (read-only)
Returns the classification category of the product variation group.
Please note that the classification category is always inherited
from the master and cannot be overridden by the variation group.
custom
custom: CustomAttributes (read-only)
Returns the custom attributes of the variation group.
Custom attributes are inherited from the master product and can
be overridden by the variation group.
image
image: MediaFile (read-only)
Returns the image of the product variation group.
If the variation group does not define an own value for 'image', the value of
the master product is returned.
longDescription
longDescription: MarkupText (read-only)
Returns the long description of the product variation group.
If the variation group does not define an own value for 'longDescription', the value of
the master product is returned.
manufacturerName
manufacturerName: String (read-only)
Returns the manufacturer name of the product variation group.
If the variation group does not define an own value for 'manufacturerName', the value of
the master product is returned.
manufacturerSKU
manufacturerSKU: String (read-only)
Returns the manufacturer sku of the product variation group.
If the variation group does not define an own value for 'manufacturerSKU', the value of
the master product is returned.
masterProduct
masterProduct: Product (read-only)
Returns the ProductMaster for this mastered product.
name
name: String (read-only)
Returns the name of the product variation group.
If the variation group does not define an own value for 'name', the value of
the master product is returned.
onlineFrom
onlineFrom: Date (read-only)
Returns the onlineFrom date of the product variation group.
If the variation group does not define an own value for 'onlineFrom', the value of
the master product is returned.
onlineTo
onlineTo: Date (read-only)
Returns the onlineTo date of the product variation group.
If the variation group does not define an own value for 'onlineTo', the value of
the master product is returned.
optionProduct
optionProduct: Boolean (read-only)
Returns 'true' if the variation group has any options, otherwise 'false'.
Method also returns 'true' if the variation group has not any options,
but the related master product has options.
pageDescription
pageDescription: String (read-only)
Returns the pageDescription of the product variation group.
If the variation group does not define an own value for 'pageDescription', the value of
the master product is returned.
pageKeywords
pageKeywords: String (read-only)
Returns the pageKeywords of the product variation group.
If the variation group does not define an own value for 'pageKeywords', the value of
the master product is returned.
pageTitle
pageTitle: String (read-only)
Returns the pageTitle of the product variation group.
If the variation group does not define an own value for 'pageTitle', the value of
the master product is returned.
pageURL
pageURL: String (read-only)
Returns the pageURL of the product variation group.
If the variation group does not define an own value for 'pageURL', the value of
the master product is returned.
productLinks
productLinks: Collection (read-only)
Returns all product links of the product variation group for which the target
product is assigned to the current site catalog.
If the variation group does not define any product links, but the master product
does, the product links of the master are returned.
shortDescription
shortDescription: MarkupText (read-only)
Returns the short description of the product variation group.
If the variation group does not define an own value for 'shortDescription', the value of
the master product is returned.
taxClassID
taxClassID: String (read-only)
Returns the tax class id of the product variation group.
If the variation group does not define an own value for 'taxClassID', the value of
the master product is returned.
template
template: String (read-only)
Returns the rendering template name of the product variation group.
If the variation group does not define an own value for 'template', the value of
the master product is returned.
thumbnail
thumbnail: MediaFile (read-only)
Returns the thumbnail image of the product variation group.
If the variation group does not define an own value for 'thumbnailImage', the value of
the master product is returned.
unit
unit: String (read-only)
Returns the sales unit of the product variation group as defined by the
master product.
If the variation group does not define an own value for 'unit', the value of
the master product is returned.
unitQuantity
unitQuantity: Quantity (read-only)
Returns the unitQuantity of the product variation group as defined by the
master product.
If the variation group does not define an own value for 'unitQuantity', the value of
the master product is returned.
Method Details
getAllProductLinks()
getAllProductLinks(): Collection
Returns all product links of the product variation group.
If the variation group does not define any product links, but the master product
does, the product links of the master are returned.
Returns:
All product links of the variation group or master
getAllProductLinks(Number)
getAllProductLinks(type: Number ): Collection
Returns all product links of the specified type of the product variation group.
If the variation group does not define any product links, but the master product
does, the product links of the master are returned.
Parameters:
type - Type of the product link
Returns:
Product links of specified type of the variation group or master
getBrand()
getBrand(): String
Returns the brand of the product variation group.
If the variation group does not define an own value for 'brand', the value of
the master product is returned.
Returns:
The brand of the variation group or master
getClassificationCategory()
getClassificationCategory(): Category
Returns the classification category of the product variation group.
Please note that the classification category is always inherited
from the master and cannot be overridden by the variation group.
Returns:
The classification category as defined for the master product of the variation group
getCustom()
getCustom(): CustomAttributes
Returns the custom attributes of the variation group.
Custom attributes are inherited from the master product and can
be overridden by the variation group.
Returns:
the custom attributes of the variation group.
getEAN()
getEAN(): String
Returns the EAN of the product variation group.
If the variation group does not define an own value for 'EAN', the value of
the master product is returned.
Returns:
The EAN of the variation group or master
getImage()
getImage(): MediaFile
Returns the image of the product variation group.
If the variation group does not define an own value for 'image', the value of
the master product is returned.
Returns:
The image of the variation group or master
getLongDescription()
getLongDescription(): MarkupText
Returns the long description of the product variation group.
If the variation group does not define an own value for 'longDescription', the value of
the master product is returned.
Returns:
The long description name of the variation group or master
getManufacturerName()
getManufacturerName(): String
Returns the manufacturer name of the product variation group.
If the variation group does not define an own value for 'manufacturerName', the value of
the master product is returned.
Returns:
The manufacturer name of the variation group or master
getManufacturerSKU()
getManufacturerSKU(): String
Returns the manufacturer sku of the product variation group.
If the variation group does not define an own value for 'manufacturerSKU', the value of
the master product is returned.
Returns:
The manufacturer sku of the variation group or master
getMasterProduct()
getMasterProduct(): Product
Returns the ProductMaster for this mastered product.
Returns:
the ProductMaster of this mastered product
getName()
getName(): String
Returns the name of the product variation group.
If the variation group does not define an own value for 'name', the value of
the master product is returned.
Returns:
The name of the variation group or master
getOnlineFrom()
getOnlineFrom(): Date
Returns the onlineFrom date of the product variation group.
If the variation group does not define an own value for 'onlineFrom', the value of
the master product is returned.
Returns:
The onlineFrom date of the variation group or master
getOnlineTo()
getOnlineTo(): Date
Returns the onlineTo date of the product variation group.
If the variation group does not define an own value for 'onlineTo', the value of
the master product is returned.
Returns:
The onlineTo date of the variation group or master
getPageDescription()
getPageDescription(): String
Returns the pageDescription of the product variation group.
If the variation group does not define an own value for 'pageDescription', the value of
the master product is returned.
Returns:
The pageDescription of the variation group or master
getPageKeywords()
getPageKeywords(): String
Returns the pageKeywords of the product variation group.
If the variation group does not define an own value for 'pageKeywords', the value of
the master product is returned.
Returns:
The pageKeywords of the variation group or master
getPageTitle()
getPageTitle(): String
Returns the pageTitle of the product variation group.
If the variation group does not define an own value for 'pageTitle', the value of
the master product is returned.
Returns:
The pageTitle of the variation group or master
getPageURL()
getPageURL(): String
Returns the pageURL of the product variation group.
If the variation group does not define an own value for 'pageURL', the value of
the master product is returned.
Returns:
The pageURL of the variation group or master
getProductLinks()
getProductLinks(): Collection
Returns all product links of the product variation group for which the target
product is assigned to the current site catalog.
If the variation group does not define any product links, but the master product
does, the product links of the master are returned.
Returns:
Product links of the variation group or master
getProductLinks(Number)
getProductLinks(type: Number ): Collection
Returns all product links of the specified type of the product variation group
for which the target product is assigned to the current site catalog.
If the variation group does not define any product links of the specified type,
but the master product does, the product links of the master are returned.
Parameters:
type - Type of the product link
Returns:
Product links of specified type of the variation group or master
getRecommendations(Number)
getRecommendations(type: Number ): Collection
Retrieve the sorted collection of recommendations of the specified type
for this product variation group. The types (cross-sell, up-sell, etc) are
enumerated in the dw.catalog.Recommendation class. Only
recommendations which are stored in the current site catalog are returned.
Furthermore, a recommendation is only returned if the target of the
recommendation is assigned to the current site catalog.
If the variation group does not define any recommendations, but the master
product does, the recommendations of the master are returned.
Parameters:
type - the recommendation type
Returns:
the sorted collection, never null but possibly empty.
getShortDescription()
getShortDescription(): MarkupText
Returns the short description of the product variation group.
If the variation group does not define an own value for 'shortDescription', the value of
the master product is returned.
Returns:
The short description name of the variation group or master
getTaxClassID()
getTaxClassID(): String
Returns the tax class id of the product variation group.
If the variation group does not define an own value for 'taxClassID', the value of
the master product is returned.
Returns:
The tax class id of the variation group or master
getTemplate()
getTemplate(): String
Returns the rendering template name of the product variation group.
If the variation group does not define an own value for 'template', the value of
the master product is returned.
Returns:
The rendering template name of the variation group or master
getThumbnail()
getThumbnail(): MediaFile
Returns the thumbnail image of the product variation group.
If the variation group does not define an own value for 'thumbnailImage', the value of
the master product is returned.
Returns:
The thumbnail image of the variation group or master
getUPC()
getUPC(): String
Returns the UPC of the product variation group.
If the variation group does not define an own value for 'UPC', the value of
the master product is returned.
Returns:
The UPC of the variation group or master
getUnit()
getUnit(): String
Returns the sales unit of the product variation group as defined by the
master product.
If the variation group does not define an own value for 'unit', the value of
the master product is returned.
Returns:
The sales unit of the variation group or master
getUnitQuantity()
getUnitQuantity(): Quantity
Returns the unitQuantity of the product variation group as defined by the
master product.
If the variation group does not define an own value for 'unitQuantity', the value of
the master product is returned.
Returns:
The unitQuantity of the variation group or master
isOptionProduct()
isOptionProduct(): Boolean
Returns 'true' if the variation group has any options, otherwise 'false'.
Method also returns 'true' if the variation group has not any options,
but the related master product has options.
Returns:
true if the variation group has any options, false otherwise.
j