Class VariantService

Namespace

Dynamicweb.Ecommerce.Variants

Assembly

Dynamicweb.Ecommerce.dll

public class VariantService

Inheritance

object

VariantService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddGroupToProduct(string, string)

Adds a product relation to the specified variant group.

public virtual void AddGroupToProduct(string productId, string variantGroupId)

Parameters

productId string

Id of product

variantGroupId string

Id of variant group

Remarks

Deletes all variants for product

BuildFamily(string, IEnumerable<string>, string, bool)

public virtual void BuildFamily(string masterProductId, IEnumerable<string> productIds, string languageId, bool canChangeMasterProduct)

Parameters

masterProductId string

productIds IEnumerable<string>

languageId string

canChangeMasterProduct bool

BuildFamilyAsVariants(string, List<ProductInfo>, List<string>)

public virtual void BuildFamilyAsVariants(string masterProductId, List<CombineProductsData.ProductInfo> productCombinationInfos, List<string> variantGroupIds)

Parameters

masterProductId string

productCombinationInfos List<CombineProductsData.ProductInfo>

variantGroupIds List<string>

ClearCache()

Clears all caches used by everything related to variants

public void ClearCache()

ClearVariantCombinationCache()

Clears the variant combination cache.

public virtual void ClearVariantCombinationCache()

ClearVariantGroupCache()

Clears the cache for variant groups

public virtual void ClearVariantGroupCache()

ClearVariantGroupOptionValuesCache()

Clears the variant group option values

public virtual void ClearVariantGroupOptionValuesCache()

ClearVariantGroupProductRelationCache()

Clears the variant group product relations

public virtual void ClearVariantGroupProductRelationCache()

ClearVariantGroupPropertiesCache()

Clears the cache for variant group properties

public virtual void ClearVariantGroupPropertiesCache()

ClearVariantOptionsCache()

Clears the cache for variant options

public virtual void ClearVariantOptionsCache()

CreateExtendedVariant(Product, IEnumerable<string>)

Creates a variant for the product.

public virtual void CreateExtendedVariant(Product product, IEnumerable<string> optionIds)

Parameters

product Product

Product

optionIds IEnumerable<string>

Ids of variant options

CreateSimpleVariant(string, IEnumerable<string>)

Creates a variant for the product.

public virtual void CreateSimpleVariant(string productId, IEnumerable<string> optionIds)

Parameters

productId string

Id of product

optionIds IEnumerable<string>

Ids of variant options

Delete(VariantGroup)

Deletes the specified variant group and the options used by this group.

public virtual void Delete(VariantGroup group)

Parameters

group VariantGroup

The variant group

Delete(VariantOption)

public virtual void Delete(VariantOption variantOption)

Parameters

variantOption VariantOption

DeleteAllVariants(string)

Deletes all variants of product.

public virtual void DeleteAllVariants(string productId)

Parameters

productId string

Id of product

DeleteVariant(string, string)

Deletes a specific variant of a product.

public virtual void DeleteVariant(string productId, string variantId)

Parameters

productId string

Id of product

variantId string

Id of variant

DeleteVariantGroup(string)

Deletes the specified variant group and the options used by this group.

public virtual void DeleteVariantGroup(string variantGroupId)

Parameters

variantGroupId string

Id of variant group

DeleteVariantOption(string)

public virtual void DeleteVariantOption(string variantOptionId)

Parameters

variantOptionId string

ExtendAllVariants(Product)

Creates extended variants for all simple variant combinations of the product.

public virtual void ExtendAllVariants(Product product)

Parameters

product Product

The product

GetAllOptions()

Gets all variant options, ordered by their respective sorting.

public virtual IEnumerable<VariantOption> GetAllOptions()

Returns

IEnumerable<VariantOption>

variantOptions

GetOptions(string, VariantGroup)

Gets the variant options matching the parameters.

public virtual IList<VariantOption> GetOptions(string productId, VariantGroup variantGroup)

Parameters

productId string

Id of product

variantGroup VariantGroup

VariantGroup

Returns

IList<VariantOption>

variantOptions

GetOptions(string, string)

Gets the variant options matching the parameters.

public virtual IList<VariantOption> GetOptions(string productId, string variantGroupId)

Parameters

productId string

Id of product

variantGroupId string

Id of variantgroup

Returns

IList<VariantOption>

variantOptions

GetVariantGroup(string)

Gets variant group.

public virtual VariantGroup? GetVariantGroup(string variantGroupId)

Parameters

variantGroupId string

Id of variant group

Returns

VariantGroup

variantGroup

GetVariantName(string, string?)

Gets the variant name.

public virtual string GetVariantName(string variantId, string? languageId = null)

Parameters

variantId string

Id of variant

languageId string

Id of language

Returns

string

variantName

PotentialVariantCount(string)

Yields a count of all possible variants.

public virtual ulong? PotentialVariantCount(string productId)

Parameters

productId string

Product id

Returns

ulong?

numberOfPotentialVariants

Remarks

If count exceeds 10000000, return nothing

RemoveAllGroupsFromProduct(string)

Removes all variant groups from specified product, for all languages.

public virtual void RemoveAllGroupsFromProduct(string productId)

Parameters

productId string

Id of product

Remarks

Deletes all variants for product

RemoveGroupFromProduct(string, string)

Removes all variant groups from specified product and language.

public virtual void RemoveGroupFromProduct(string productId, string variantGroupId)

Parameters

productId string

Id of product

variantGroupId string

Id of variant group

Remarks

Deletes all variants for product

Save(VariantCombination)

Saves the variant.

public virtual void Save(VariantCombination variantCombination)

Parameters

variantCombination VariantCombination

Variant

Save(VariantGroup)

Saves the variant group.

public virtual void Save(VariantGroup group)

Parameters

group VariantGroup

VariantGroup

Save(VariantOption)

public virtual void Save(VariantOption variantOption)

Parameters

variantOption VariantOption

Save(IEnumerable<VariantCombination>)

public virtual void Save(IEnumerable<VariantCombination> variantCombinations)

Parameters

variantCombinations IEnumerable<VariantCombination>