SKUInfoProvider Class

Class providing SKUInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<SKUInfo, SKUInfoProvider, ObjectQuery<SKUInfo>>
    CMS.DataEngine.AbstractInfoProvider<SKUInfo, SKUInfoProvider>
      CMS.Ecommerce.SKUInfoProvider

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

Syntax

public class SKUInfoProvider : AbstractInfoProvider<SKUInfo, SKUInfoProvider>, 
	ISKUInfoProvider, IInfoProvider<SKUInfo>, IInfoByIdProvider<SKUInfo>, 
	IInfoByGuidProvider<SKUInfo>

The SKUInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	SKUInfoProvider	Constructor.

Fields

	Name	Description
Protected field	infos	Info tables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Properties

	Name	Description
Public property	DataSource	Data source for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	HashtableSettings	Gets hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public property	TypeInfo	Object type information. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)

Methods

	Name	Description
Protected method	BeginTransaction	Creates a new transaction over this provider. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkDelete	Bulk deletes info objects based on the given condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<BaseInfo>)	Bulk inserts the given list of info objects (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	BulkInsertInfos(IEnumerable<TInfo>, BulkInsertSettings)	Bulk inserts the given list of info objects. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	CheckDependencies	Checks dependencies, returns true if dependent.
Public method Static member	CheckLicense	Checks the license.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CleanUpProductTypeDependenciesInternal	Cleans up product type dependencies like e-product files, bundle relations, Memberships etc.
Protected method	ClearHashtables	Clears the object's hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateDefaultBulkInsertSettings	Creates bulk insert settings. By default CheckConstraints and TableLock flags are set. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	CreateInfo	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	CreateWebFarmTask(String, String, Byte[], String)	Creates web farm task specific for current object and action name (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Delete	Deletes the info object from the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Delete(TInfo).)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	DeleteSKUInfo(Int32)	Obsolete. Deletes product with specified ID.
Public method Static member	DeleteSKUInfo(SKUInfo)	Obsolete. Deletes specified product.
Protected method	DeleteSKUInfoInternal	Obsolete. Deletes specified product.
Public method	Get()	Gets the object query for TInfo retrieval. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid)	Gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Int32)	Gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String)	Gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(Guid, Int32)	Gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	Get(String, Int32)	Gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(Guid, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its GUID and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetAsync(String, Int32, Nullable<CancellationToken>)	Asynchronously gets an instance of info object based on its code name and site ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetBundleItems	Returns query for all bundle items for specified bundle SKU ID.
Protected method	GetBundleItemsInternal	Returns query for all bundle items for specified bundle SKU ID.
Public method Static member	GetDefaultNeedsShippingFlag	Returns default value of NeedsShipping flag for given representation of product.
Protected method	GetDefaultNeedsShippingFlagInternal	Returns default value of NeedsShipping flag for given representation of product.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByFullName	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the given GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)	Asynchronously gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoById	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfoByIdAsync	Asynchronously gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetObjectCountForLicenseCheck	Returns the amount of objects that are limited by license conditions.
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetSKUInfo(Guid)	Obsolete. Returns product with specified GUID.
Public method Static member	GetSKUInfo(Int32)	Obsolete. Returns product with specified ID.
Protected method	GetSKUInfoInternal(Guid)	Obsolete. Returns product with specified GUID.
Protected method	GetSKUInfoInternal(Int32)	Obsolete. Returns product with specified ID.
Public method Static member	GetSKUOptions	Returns query for all product options from specified product option category.
Public method Static member	GetSKUOptionsForProduct	Returns query for all product options from specified product option category allowed for product specified by skuId parameter.
Protected method	GetSKUOptionsForProductInternal	Returns query for all product options from specified product option category allowed for product specified by skuId parameter.
Public method Static member	GetSKUs()	Obsolete. Returns the query for all products and product option.
Public method Static member	GetSKUs(Int32)	Returns query for all SKUs for specified site.
Protected method	GetSKUsInternal	Returns query for all SKUs for specified site.
Public method Static member	GetSKUUrl(Guid, String, String)	Obsolete. Returns user friendly URL of the specified product. Does not uses hash tables to crate SKU.
Public method Static member	GetSKUUrl(Int32, String, String)	Obsolete. Returns user friendly URL of the specified product. Uses hash tables.
Protected method	GetSKUUrlInternal(Guid, String, String)	Obsolete. Returns user friendly URL of the specified product.
Protected method	GetSKUUrlInternal(Int32, String, String)	Obsolete. Returns user friendly URL of the specified product. Method uses hash tables.
Public method Static member	GetWishlistProducts	Returns dataset with the products from specified user's wishlist.
Protected method	GetWishlistProductsInternal	Returns dataset with the products from specified user's wishlist.
Public method Static member	HasSKUEnabledOptions	Returns True if there are any options categories with some enabled product options assigned to the specified SKU, otherwise returns False.
Protected method	HasSKUEnabledOptionsInternal	Returns True if there are any options categories with some enabled product options assigned to the specified SKU, otherwise returns False.
Protected method	Init	Initializes the provider with the given type info and hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitHashtableSettings	Initializes the HashtableSettings based on typeInfo and using settings as default values. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	InitTypeInfoAndRegister	Initializes the provider variables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Invalidate	Sets this provider as invalid (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	IsSKUAvailableForSale	Indicates if the given SKU can be bought by the customer based on the SKU inventory properties.
Protected method	IsSKUAvailableForSaleInternal	Indicates if the given SKU can be bought by the customer based on the SKU inventory settings.
Public method Static member	IsSKUInStock	Indicates the real stock status of SKU based on SKU items available.
Protected method	IsSKUInStockInternal	Indicates the real stock status of SKU based on SKU items available.
Public method Static member	IsSKUNew	Indicates if the given SKU is new in the store. By default it is determined based on the CMSStoreProductsAreNewFor setting and SKUInStoreFrom property.
Protected method	IsSKUNewInternal	Indicates if the given SKU is new in the store. By default it is determined based on the CMSStoreProductsAreNewFor setting and SKUInStoreFrom property.
Public method Static member	IsUserAuthorizedToModifySKU(SKUInfo, String, IUserInfo)	Indicates if user is authorized to modify specific SKU. For global SKU: 'EcommerceGlobalModify' permission is checked. For site-specific SKU: 'EcommerceModify' OR 'ModifyProducts' permission is checked.
Public method Static member	IsUserAuthorizedToModifySKU(Boolean, String, IUserInfo, Boolean)	Indicates if user is authorized to modify SKUs.
Public method Static member	LicenseVersionCheck	License version check.
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	ProcessWebFarmTaskInternal	Runs the processing of specific web farm task for current provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	Set	Inserts or updates the info object in the underlying data store. (Overrides AbstractInfoProvider<TInfo, TProvider>.Set(TInfo).)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider. Since the providers are managed by IoC container, setting the provider instance must be performed before the IoC container initialization finishes (i.e. during application pre-initialization). (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetSKUInfo	Obsolete. Sets (updates or inserts) specified product.
Protected method	SetSKUInfoInternal	Obsolete. Sets (updates or inserts) specified product.
Public method Static member	SortProductOptionsAlphabetically	Sorts product options of the specified option category alphabetically (A-Z).
Protected method	SortProductOptionsAlphabeticallyInternal	Sorts product options of the specified option category alphabetically (A-Z).
Protected method	UpdateData(String, QueryDataParameters, String)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Protected method	UpdateData(IWhereCondition, IEnumerable<KeyValuePair<String, Object>>, Boolean)	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	UpdateInventory	Updates products' available items according to the products' units of the specified shopping cart.
Protected method	UpdateInventoryInternal	Updates products' available items in database according to the products' units of the specified shopping cart.
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)