ECommerceContext Class

E-commerce context.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<ECommerceContext>
    CMS.Base.AbstractDataContainer<ECommerceContext>
      CMS.Base.AbstractHierarchicalObject<ECommerceContext>
        CMS.Base.ContextContainer<ECommerceContext>
          CMS.Base.AbstractContext<ECommerceContext>
            CMS.Ecommerce.ECommerceContext

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

Syntax

public class ECommerceContext : AbstractContext<ECommerceContext>

The ECommerceContext type exposes the following members.

Constructors

	Name	Description
Public method	ECommerceContext

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property Static member	CurrentCurrency	Current currency.
Public property Static member	CurrentCustomer	Customer from current shopping cart.
Public property Static member	CurrentCustomerCountry	Current customer country.
Public property Static member	CurrentCustomerState	Current customer state.
Public property Static member	CurrentManufacturer	Current manufacturer object according the URL parameter of the current request. It is available when the request contains parameters "manufacturerId" or "manufacturerName" with valid value of the manufacturer.
Public property Static member	CurrentProduct	Current product.
Public property Static member	CurrentProductDepartment	Current product department.
Public property Static member	CurrentProductInternalStatus	Current product internal status.
Public property Static member	CurrentProductPublicStatus	Current product public status.
Public property Static member	CurrentProductSupplier	Current product supplier.
Public property Static member	CurrentShoppingCart	Gets or sets the current shopping cart. The cart is retrieved using the GetCurrentShoppingCart() method while setting the cart is done by SetCurrentShoppingCart(ShoppingCartInfo) method. The property is cached per web request and is available only within the context of a web request. The underlying services can be used directly when caching is not required.
Public property	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
Public property Static member	IsExchangeRateFromGlobalMainCurrencyMissing	Indicates if exchange rate from global main currency is missing in the last valid exchange table. Returns false if site uses global currencies or global exchange rates or code of site main currency is the same as code of global main currency.
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Key	Unique container key (Inherited from ContextContainer<TParent>.)
Public property Static member	MoreCurrenciesUsedOnSite	Returns true, if more than one currency is used and enabled on current site, otherwise false.
Public property Static member	OnlyOnePaymentOptionAvailableOnSite	Returns true, if there is only one payment option available on current site, otherwise false.
Public property Static member	OnlyOneShippingOptionAvailableOnSite	Returns true, if there is only one shipping option available on current site, otherwise false.
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)

Methods

	Name	Description
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method	CloneForNewThread	Clones the object for new thread (Inherited from AbstractContext<TContext>.)
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	EnsureCurrent	Creates the internal ContextContainer<TParent> storage if it does not exist yet. (Inherited from ContextContainer<TParent>.)
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method Static member	InvalidateCurrentShoppingCartCache	Invalidates the current shopping cart in a per request cache used by the CurrentShoppingCart member.
Public method Static member	IsUserAuthorizedForPermission	Checks the specified ecommerce permission for current user.
Public method Static member	IsUserAuthorizedToModifyCustomer	Indicates if user is authorized to modify specific customer. 'EcommerceModify' OR 'ModifyCustomers' permission is checked.
Public method Static member	IsUserAuthorizedToModifyDiscount	Indicates if user is authorized to modify discounts.
Public method Static member	IsUserAuthorizedToModifyManufacturer(Boolean)	Indicates if user is authorized to modify manufacturers.
Public method Static member	IsUserAuthorizedToModifyManufacturer(ManufacturerInfo)	Indicates if current user is authorized to modify specific manufacturer. For global manufacturer: 'EcommerceGlobalModify' permission is checked. For site-specific manufacturer: 'EcommerceModify' OR 'ModifyManufacturers' permission is checked.
Public method Static member	IsUserAuthorizedToModifyOptionCategory(Boolean)	Indicates if user is authorized to modify option categories.
Public method Static member	IsUserAuthorizedToModifyOptionCategory(OptionCategoryInfo)	Indicates if user is authorized to modify specific option category. For global option category: 'EcommerceGlobalModify' permission is checked. For site-specific manufacturer: 'EcommerceModify' OR 'ModifyProducts' permission is checked.
Public method Static member	IsUserAuthorizedToModifySKU(Boolean)	Indicates if user is authorized to modify SKUs.
Public method Static member	IsUserAuthorizedToModifySKU(SKUInfo)	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	IsUserAuthorizedToModifySupplier(Boolean)	Indicates if user is authorized to modify suppliers.
Public method Static member	IsUserAuthorizedToModifySupplier(SupplierInfo)	Indicates if user is authorized to modify specific supplier. For global supplier: 'EcommerceGlobalModify' permission is checked. For site-specific supplier: 'EcommerceModify' OR 'ModifySuppliers' permission is checked.
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetAsCurrent	Sets the current instance as the current thread item (Inherited from ContextContainer<TParent>.)
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)