ShippingOptionInfoProvider Class

Class providing ShippingOptionInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.BaseAbstractInfoProvider
      CMS.DataEngine.AbstractInfoProvider<ShippingOptionInfoProvider>
        CMS.DataEngine.AbstractInfoProvider<ShippingOptionInfo, ShippingOptionInfoProvider>
          CMS.Ecommerce.ShippingOptionInfoProvider

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

Syntax

public class ShippingOptionInfoProvider : AbstractInfoProvider<ShippingOptionInfo, ShippingOptionInfoProvider>

The ShippingOptionInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	ShippingOptionInfoProvider	Constructor.

Methods

	Name	Description
Public method	AddSiteWhereCondition(String, Int32, String, Boolean)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	AddSiteWhereCondition(String, Int32, String, Boolean, String)	Creates site where condition from the specified parameters and adds it to the original where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	BoundGetInfoByGuid(Guid)	Gets the info object by its GUID (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	BoundGetInfoByGuid(Guid, Int32)	Gets the info object by its GUID and site ID (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	BoundGetInfoById	Gets the info by ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	BoundGetInfoByName(String)	Gets the info object by its code name (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	BoundGetInfoByName(String, Int32)	Gets the info object by its code name and site Id (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	BoundGetInfosByIds	Gets the list of info objects by their IDs (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	CalculateShipping	Calculates shipping cost for the given shopping cart. Shipping free limit is applied. Shipping taxes are not included. Result is in site main currency.
Public method Static member	CalculateShippingDiscount	Calculates shipping discount for supplied shopping cart. Uses ShippingDiscounts collection of cart. Resulting discount will not be higher that shipping.
Protected method	CalculateShippingDiscountInternal	Calculates shipping discount for supplied shopping cart. Uses ShippingDiscounts collection of cart. Resulting discount will not be higher that shipping.
Protected method	CalculateShippingInternal	Calculates shipping cost for the given shopping cart. Shipping free limit is applied. Shipping taxes are not included. Result is in site main currency.
Public method Static member	CalculateShippingTax	Calculates tax value of the shipping option for the given shopping cart. Result is in site main currency.
Protected method	CalculateShippingTaxInternal	Calculates tax value of the shipping option for the given shopping cart. Result is in site main currency.
Public method Static member	CalculateTotalShipping	Calculates total shipping for the given shopping cart. Shipping taxes are included. Result is site main currency.
Protected method	CalculateTotalShippingInternal	Calculates total shipping for the given shopping cart. Shipping taxes are included. Result is site main currency.
Public method Static member	Clear	Clears hashtables.
Protected method	ClearHashtables	Clear hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	CreateHashtables	Creates the provider hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	CreateInfo(Int32)	Creates an instance of info object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	CreateInfo(DataRow, Boolean)	Creates a new info object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method	CreateWebFarmTask(String, String, Byte[])	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Protected method	DeleteData(String)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteData(IWhereCondition)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteData(Action<ObjectQuery<TInfo>>)	Deletes the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteInfo	Deletes the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	DeleteShippingOptionInfo(Int32)	Deletes shipping option with specified ID.
Public method Static member	DeleteShippingOptionInfo(ShippingOptionInfo)	Deletes specified shipping option.
Protected method	DeleteShippingOptionInfoInternal	Deletes specified shipping option.
Public method	GetBindingWhereCondition(String, Int32)	Gets the where condition to limit the objects to specific binding dependency. Use this method only for 2-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetBindingWhereCondition(String, Object[])	Gets the where condition to limit the objects to specific binding dependencies. Use this method for 3 and more-keys bindings. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetCacheDependency(DataSet, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetCacheDependency(BaseInfo, String, String)	Gets the cache dependency for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetCountInternal	Gets the number of items matching the given parameters. Does not check the license when retrieving data. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetData(QueryDataParameters, String, String, Int32, String, Boolean, Int32, Int32, Int32, Int32)	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDataByColumn<T>	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDataByGuidColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDataByIntColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDataByStringColumn	Returns the data according to the set of input parameters. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDependencyCacheKeys(DataSet, String, String)	Gets the cache dependency keys for the given DataSet. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetDependencyCacheKeys(GeneralizedInfo, String, String)	Gets the cache dependency keys for the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetEmptyDataSet	Gets the empty data set to be filled by the data (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetExistingIDsInternal	Filters out all object IDs that do not exist in the database. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetFormattedWeight	Returns weight formatted according site specific weight format string. If no format string specified, uses x.xx format instead.
Protected method	GetFormattedWeightInternal	Returns weight formatted according site specific weight format string. If no format string specified, uses x.xx format instead.
Protected method	GetFullNameDictionary	Creates new dictionary for caching the objects by full name (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetFullNameWhereCondition	Gets the where condition that searches the object based on the given full name (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfo(IWhereCondition)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfo(Action<ObjectQuery<TInfo>>)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfo(String, String)	Gets an instance of the first info object matching the specified condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String, Int32)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String, Int32, Int32)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String, Int32, Boolean, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeName(String, Int32, Int32, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByCodeNameFromDB	Gets an instance of info object based on the given code name from database (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByFullName(String)	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByFullName(String, Boolean)	Gets an instance of info object based on the given full name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByFullNameInternal	Gets the info by its full name from the database (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByGuid(Guid)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByGuid(Guid, Boolean)	Gets an instance of info object based on the given code name. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByGuid(Guid, Int32)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByGuid(Guid, Int32, Boolean)	Gets an instance of info object based on the GUID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByGuidColumn	Gets an instance of info object based on the string column value. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByGuidFromDB	Gets an instance of info object based on the given GUID from database (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoById(Int32)	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoById(Int32, Boolean)	Gets an instance of info object based on ID. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByIntColumn	Gets an instance of info object based on the integer column value. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfoByStringColumn	Gets an instance of info object based on the string column value. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetInfosByIds	Gets the list of info objects by their IDs (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetObjectQuery	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetObjectQueryInternal	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetParentWhereCondition	Gets the where condition to limit the objects to specific parent. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	GetShippingOptionInfo(Int32)	Returns shipping option with specified ID.
Public method Static member	GetShippingOptionInfo(String, String)	Returns shipping option with specified name.
Protected method	GetShippingOptionInfoInternal(Int32)	Returns shipping option with specified ID.
Protected method	GetShippingOptionInfoInternal(String, String)	Returns shipping option with specified name.
Public method Static member	GetShippingOptions()	Returns the query for all shipping options.
Public method Static member	GetShippingOptions(Int32, Boolean)	Returns dataset of all shipping options matching the specified parameters.
Protected method	GetShippingOptionsInternal	Returns dataset of all shipping options matching the specified parameters.
Protected method	GetSingleObject	Gets the object query for the provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetSiteWhereCondition(Int32)	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	GetSiteWhereCondition(Int32, Boolean)	Gets the where condition to limit the objects to specific site. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	GetTypeInfo	Gets the type info for this provider (Inherited from BaseAbstractInfoProvider.)
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>.)
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>.)
Protected method	Init	Initializes the provider variables. (Inherited from BaseAbstractInfoProvider.)
Protected method	InitHashtables	Initializes the hashtable settings (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
Public method Static member	IsShippingNeeded	Check if shopping cart needs shipping, return true if it does.
Protected method	IsShippingNeededInternal	Check if shopping cart needs shipping, return true if it does.
Public method Static member	IsShippingOptionApplicable	Checks if shipping option is applicable in given shopping cart.
Protected method	IsShippingOptionApplicableInternal	Checks if shipping option is applicable for given shopping cart.
Protected method	LoadAllInfos	Loads all infos to the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	LoadGeneration	Loads the specified generation of the objects. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	LoadInfos	Loads all objects from the database to memory. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	LoadObjectsToHashtables	Loads the objects from a DataSet to the hashtables (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	NewTransaction	Creates a new transaction over this provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from BaseAbstractInfoProvider.)
Protected method	RecalculateData	Recalculates the value in the given column using the coefficient. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	RecalculateShippingOptions	Recalculates options charges and their shipping costs using the given coefficient.
Protected method	RecalculateShippingOptionsInternal	Recalculates options charges and their shipping costs using the given coefficient.
Public method	RefreshObjectsCounts	Updates all counts for all sub-objects. (Inherited from BaseAbstractInfoProvider.)
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
Protected method	RegisterObjectInHashtables	Registers the object instance within the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	RemoveOriginalCodeNameFromHashtable	Removes the original object code name from the hashtable (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	ReplaceData	Replaces the data in the given columns. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	ResetToDefault	Resets the provider to default implementation (Inherited from AbstractInfoProvider<TProvider>.)
Public method	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TProvider>.)
Protected method	SetInfo	Inserts or Updates the object to the database. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method Static member	SetShippingOptionInfo	Sets (updates or inserts) specified shipping option.
Protected method	SetShippingOptionInfoInternal	Sets (updates or inserts) specified shipping option.
Public method	SortAlphabetically	Sorts the object alphabetically. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	TouchCacheDependencies	Touches the cache dependencies of the given object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	UpdateData	Updates the data in the database based on the given where condition. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Protected method	UpdateObjectInHashtables	Updates the object instance in the hashtables. Updates is different than register, because it logs task about changing object. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	UseSource(TInfo[])	Sets the provider to use given data as data source (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public method	UseSource(DataQuerySource)	Sets the provider to use given data as data source (Inherited from BaseAbstractInfoProvider.)
Public method	ValidateCodeName	Validates the object code name. Returns true if the code name is valid. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	hashtableLock	Table lock for loading hashtables (Inherited from BaseAbstractInfoProvider.)
Protected field	infos	Info tables. (Inherited from BaseAbstractInfoProvider.)
Protected field	mTypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)

Properties

	Name	Description
Protected property	DataSource	Data source for the provider (Inherited from BaseAbstractInfoProvider.)
Protected property	GenerationColumn	Obsolete. Column used to filter the data according the generation in which the items should be loaded. (Inherited from BaseAbstractInfoProvider.)
Public property	HashtableSettings	Hashtable settings (Inherited from BaseAbstractInfoProvider.)
Protected property	InfoObject	Info object instance the provider is working with. (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public property	InfoType	Returns the type of the info object for this provider (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public property	IsDataAvailable	Returns true if the data is available for this provider (Inherited from BaseAbstractInfoProvider.)
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractProvider.)
Protected property	LoadHashtables	Obsolete. Determines the mode in which the hashtables should be loaded. In case the hashtables are loaded through generations, you must also specify the GenerationColumn property. (Inherited from BaseAbstractInfoProvider.)
Protected property	ProviderName	Provider name (Inherited from BaseAbstractInfoProvider.)
Public property	StoreEmptyValuesInHashtables	If true, provider hashtables store empty values for not found objects to reduce database calls (Inherited from AbstractInfoProvider<TInfo, TProvider>.)
Public property	TypeInfo	Object type information. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseFullNameHashtable	Obsolete. If true, the full name hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseGUIDHashtable	Obsolete. If true, the guid hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseHashtables	Obsolete. If true, the provider uses hashtables. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseIDHashtable	Obsolete. If true, the ID hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseNameHashtable	Obsolete. If true, the code name hashtable is allowed to be used. (Inherited from BaseAbstractInfoProvider.)
Protected property	UseWeakReferences	Obsolete. If true, the weak references are used for the items so the memory can be cleared upon request (Inherited from BaseAbstractInfoProvider.)