VariantHelper Class

Provides advanced manipulation with product variants.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<VariantHelper>
        CMS.Ecommerce.VariantHelper

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 12.0.0

Syntax

public class VariantHelper : AbstractHelper<VariantHelper>

The VariantHelper type exposes the following members.

Constructors

	Name	Description
Public method	VariantHelper

Methods

	Name	Description
Public method Static member	AddNewCategoriesToVariantsOfProduct	Returns existing variants of specified product with added new categories specified with default options. Categories which are already included are ignored.
Protected method	AddNewCategoriesToVariantsOfProductInternal	Returns existing variants of specified product with added new categories specified with default options. Categories which are already included are ignored.
Public method Static member	AreCategoriesUsedInVariants	Checks if the specified categories are used in variants of specified product.
Protected method	AreCategoriesUsedInVariantsInternal	Checks if the specified categories are used in variants of specified product.
Public method Static member	CheckAvailableProductAttributes	Checks if specified product options are assigned to product and are allowed in it.
Protected method	CheckAvailableProductAttributesInternal	Checks if specified product options are assigned to product and are allowed in it.
Public method Static member	CheckVariantCategoriesConsistency(Int32, ProductAttributeSet)	Checks if specified product options contains all and only categories from existing variants of specified product.
Public method Static member	CheckVariantCategoriesConsistency(Int32, IEnumerable<Int32>)	Checks if specified categories are used all and only in variants of specified product.
Protected method	CheckVariantCategoriesConsistencyInternal(Int32, ProductAttributeSet)	Checks if specified product options contains all and only categories from existing variants of specified product.
Protected method	CheckVariantCategoriesConsistencyInternal(Int32, IEnumerable<Int32>)	Checks if specified categories are used all and only in variants of specified product.
Public method Static member	CheckVariantOptions	Checks if the variant options in specified variant corresponds with options determined in parent product.
Protected method	CheckVariantOptionsInternal	Checks if the variant options in specified variant corresponds with options determined in parent product.
Public method Static member	CreateVariant	Creates new variant object (from product and options) without saving it.
Protected method	CreateVariantInternal	Creates new variant object (from product and options) without saving it.
Public method Static member	DeleteAllVariants	Deletes all variants one by one. If delete operation is successful for processing variant removeSucceededAction with variant ID as a parameter is launched.
Protected method	DeleteAllVariantsInternal	Deletes all variants one by one. If delete operation is successful for processing variant removeSucceededAction with variant ID as a parameter is launched.
Public method Static member	DeleteVariant(Int32)	Deletes the specified variant.
Public method Static member	DeleteVariant(ProductVariant)	Deletes the specified variant.
Protected method	DeleteVariantInternal	Deletes the specified variant.
Protected method	GenerateRemainingVariants	Returns list of product variants with newly generated remaining combinations for specified product but with specified variants (listOfVariants) that doesn't need to be saved yet.
Public method Static member	GetAllPossibleVariants(List<ProductVariant>)	Gets all possible variants for specified set (Returns provided variants plus remaining combinations).
Public method Static member	GetAllPossibleVariants(Int32, IEnumerable<Int32>)	Gets all possible variants for specified product and all combinations (including existing variants) of options from categories.
Public method Static member	GetAllPossibleVariantsCount	Gets number of all variants, which can be generated including existing variants of options from categories.
Protected method	GetAllPossibleVariantsCountInternal	Gets number of all variants, which can be generated including existing variants of options from categories.
Protected method	GetAllPossibleVariantsInternal(List<ProductVariant>)	Gets all possible variants for specified set (Returns provided variants plus remaining combinations).
Protected method	GetAllPossibleVariantsInternal(Int32, IEnumerable<Int32>)	Gets all possible variants for specified product and all combinations (including existing variants) of options from categories.
Public method Static member	GetEnabledOptionsWithVariantOptions	Gets options from option category assigned to sku which are enabled or already used in variants.
Protected method	GetEnabledOptionsWithVariantOptionsInternal	Gets options from option category assigned to sku which are enabled or already used in variants.
Public method Static member	GetProductVariant	Gets SKU object of product variant from parent product and options.
Protected method	GetProductVariantInternal	Gets SKU object of product variant from parent product and options.
Public method Static member	GetProductVariantsCategories	Gets the product variants categories for specified product.
Protected method	GetProductVariantsCategoriesInternal	Gets the product variants categories in the specified order for the given product.
Public method Static member	GetProductVariantsCategoryIDs	Gets the product variants category IDs for specified product.
Public method Static member	GetUsedProductOptionCategories	Gets enabled product option categories included disabled option categories used in product variants.
Protected method	GetUsedProductOptionCategoriesInternal	Gets enabled product option categories included disabled option categories used in product variants.
Public method Static member	GetVariants	Gets the variants of specified product.
Protected method	GetVariantsInternal	Gets the variants of specified product.
Public method Static member	RegenerateSKUNameAndNumber	Regenerates the SKU name and number.
Protected method	RegenerateSKUNameAndNumberInternal	Regenerates the SKU name and number.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member	SetProductVariant	Saves this instance of product variant with specified product options to database.
Protected method	SetProductVariantInternal	Saves this instance of product variant with specified product options to database.
Public method Static member	VariantExists	Determines that variant for specified product with specified options exists.
Protected method	VariantExistsInternal	Determines that variant for specified product with specified options exists.