CurrencyInfoProvider Class

Class providing CurrencyInfo management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractInfoProvider<CurrencyInfo, CurrencyInfoProvider, ObjectQuery<CurrencyInfo>>
    CMS.DataEngine.AbstractInfoProvider<CurrencyInfo, CurrencyInfoProvider>
      CMS.Ecommerce.CurrencyInfoProvider

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

Syntax

public class CurrencyInfoProvider : AbstractInfoProvider<CurrencyInfo, CurrencyInfoProvider>

The CurrencyInfoProvider type exposes the following members.

Constructors

	Name	Description
Public method	CurrencyInfoProvider	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	ChangeMainCurrency	Changes main currency.
Protected method	ChangeMainCurrencyInternal	Changes main currency.
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	ClearHashtables	Clear hashtables. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.ClearHashtables(Boolean).)
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 Static member	DeleteCurrencyInfo(Int32)	Deletes currency with specified ID.
Public method Static member	DeleteCurrencyInfo(CurrencyInfo)	Deletes specified currency.
Protected method	DeleteInfo	Deletes the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.DeleteInfo(TInfo).)
Protected method	DeleteObjectFromHashtables	Deletes the object instance from the hashtables. (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetCurrencies()	Returns the query for all currencies.
Public method Static member	GetCurrencies(Int32, Boolean)	Returns dataset of all currencies matching the specified parameters.
Public method Static member	GetCurrenciesByCode	Returns CurrencyInfo objects present on given site in form of dictionary mapping currency code to CurrencyInfo object.
Protected method	GetCurrenciesByCodeInternal	Returns CurrencyInfo objects present on given site in form of dictionary mapping currency code to CurrencyInfo object.
Protected method	GetCurrenciesInternal	Returns dataset of all currencies matching the specified parameters.
Public method Static member	GetCurrencyInfo(Int32)	Returns currency with specified ID.
Public method Static member	GetCurrencyInfo(String, String)	Returns currency with specified name.
Protected method	GetCurrencyInfoInternal	Returns currency with specified name from specified site.
Protected method	GetDeleteQuery	Gets the object query that deletes all items matching the query parameters (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	GetFormattedPrice(Decimal, CurrencyInfo, Boolean)	Returns HTML encoded (depends on encode parameter) and formatted price according to CurrencyFormatString defined for currencyObj parameter.
Public method Static member	GetFormattedPrice(Decimal, Int32, Boolean)	Returns HTML encoded (depends on encode parameter) and formatted price according to CurrencyFormatString defined for specified site main currency.
Protected method	GetFormattedPriceInternal(Decimal, CurrencyInfo, Boolean)	Returns formatted price according to formatting string of the specified currency.
Protected method	GetFormattedPriceInternal(Decimal, Int32, Boolean)	Returns formatted price according to formatting string of the specified site main currency.
Public method Static member	GetFormattedValue	Returns formatted price according to CurrencyRoundTo.
Protected method	GetFormattedValueInternal	Returns formatted price, by default formatting string "{0:0.00}" is used.
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	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	GetInfoById	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	GetMainCurrency	Returns main currency of the specified site.
Public method Static member	GetMainCurrencyCode	Returns code of main currency for given site. Returns empty string when not found.
Protected method	GetMainCurrencyCodeInternal	Returns main currency code for given site or empty string when not found.
Protected method	GetMainCurrencyInternal	Returns main currency of specified site.
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	GetRelativelyFormattedPrice(Decimal, CurrencyInfo, Boolean)	Returns HTML encoded (depends on encode parameter) and relatively formatted price according to CurrencyFormatString defined for currencyObj parameter.
Public method Static member	GetRelativelyFormattedPrice(Decimal, Int32, Boolean)	Returns HTML encoded (depends on encode parameter) and relatively formatted price according to CurrencyFormatString defined for specified site main currency.
Protected method	GetRelativelyFormattedPriceInternal(Decimal, CurrencyInfo, Boolean)	Returns relatively formatted price according to formatting string of the specified currency.
Protected method	GetRelativelyFormattedPriceInternal(Decimal, Int32, Boolean)	Returns relatively formatted price according to formatting string of the specified site main currency.
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	IsCurrencyWithExchangeRate	Returns true if site specified by its ID has defined exchange rate to given currency. Only enabled currencies are searched.
Protected method	IsCurrencyWithExchangeRateInternal	Returns true if site specified by its ID has defined exchange rate to given currency. Only enabled currencies are searched.
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	SetAsDefaultProvider	Sets this provider instance as the default provider (Inherited from AbstractInfoProvider<TInfo, TProvider, TQuery>.)
Public method Static member	SetCurrencyInfo	Sets (updates or inserts) specified currency.
Protected method	SetInfo	Inserts or Updates the object to the database. (Overrides AbstractInfoProvider<TInfo, TProvider, TQuery>.SetInfo(TInfo).)
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>.)
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>.)