Click or drag to resize
CurrencyInfoProvider Class
Class providing CurrencyInfo management.
Inheritance Hierarchy
SystemObject
  CMS.DataEngineAbstractInfoProviderCurrencyInfo, CurrencyInfoProvider, ObjectQueryCurrencyInfo
    CMS.DataEngineAbstractInfoProviderCurrencyInfo, CurrencyInfoProvider
      CMS.EcommerceCurrencyInfoProvider

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 13.0.131
Syntax
C#
public class CurrencyInfoProvider : AbstractInfoProvider<CurrencyInfo, CurrencyInfoProvider>, 
	ICurrencyInfoProvider, IInfoProvider<CurrencyInfo>, IInfoByIdProvider<CurrencyInfo>, 
	IInfoBySiteAndNameProvider<CurrencyInfo>

The CurrencyInfoProvider type exposes the following members.

Constructors
  NameDescription
Public methodCurrencyInfoProvider
Constructor.
Top
Fields
Properties
Methods
  NameDescription
Protected methodBeginTransaction
Creates a new transaction over this provider.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkDelete
Bulk deletes info objects based on the given condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableBaseInfo)
Bulk inserts the given list of info objects
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodBulkInsertInfos(IEnumerableTInfo, BulkInsertSettings)
Bulk inserts the given list of info objects.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberChangeMainCurrency
Changes main currency.
Protected methodChangeMainCurrencyInternal
Changes main currency.
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCheckUniqueValues
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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodClearHashtables
Clear hashtables.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryClearHashtables(Boolean).)
Protected methodCreateDefaultBulkInsertSettings
Creates bulk insert settings. By default CheckConstraints and TableLock flags are set.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodCreateInfo
Creates a new info object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodCreateWebFarmTask(String, String, Byte, String)
Creates web farm task specific for current object and action name
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodDelete
Deletes the info object from the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberDeleteCurrencyInfo(Int32) Obsolete.
Deletes currency with specified ID.
Public methodStatic memberDeleteCurrencyInfo(CurrencyInfo) Obsolete.
Deletes specified currency.
Protected methodDeleteInfo
Deletes the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQueryDeleteInfo(TInfo).)
Protected methodDeleteObjectFromHashtables
Deletes the object instance from the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodGet
Gets the object query for TInfo retrieval.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid)
Gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Int32)
Gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String)
Gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(Guid, Int32)
Gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGet(String, Int32)
Gets an instance of info object based on its code name and site ID.
(Overrides AbstractInfoProviderTInfo, TProviderGet(String, Int32).)
Public methodGetAsync(Guid, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(Guid, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its GUID and site ID.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodGetAsync(String, Int32, NullableCancellationToken)
Asynchronously gets an instance of info object based on its code name and site ID.
(Overrides AbstractInfoProviderTInfo, TProviderGetAsync(String, Int32, NullableCancellationToken).)
Public methodStatic memberGetCurrencies Obsolete.
Returns the query for all currencies.
Public methodStatic memberGetCurrencies(Int32, Boolean)
Returns dataset of all currencies matching the specified parameters.
Public methodStatic memberGetCurrenciesByCode
Returns CurrencyInfo objects present on given site in form of dictionary mapping currency code to CurrencyInfo object.
Protected methodGetCurrenciesByCodeInternal
Returns CurrencyInfo objects present on given site in form of dictionary mapping currency code to CurrencyInfo object.
Protected methodGetCurrenciesInternal
Returns dataset of all currencies matching the specified parameters.
Public methodStatic memberGetCurrencyInfo(Int32) Obsolete.
Returns currency with specified ID.
Public methodStatic memberGetCurrencyInfo(String, String) Obsolete.
Returns currency with specified name.
Protected methodGetCurrencyInfoInternal Obsolete.
Returns currency with specified name from specified site.
Protected methodGetDeleteQuery
Gets the object query that deletes all items matching the query parameters
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetFormattedPrice(Decimal, CurrencyInfo, Boolean)
Returns HTML encoded (depends on encode parameter) and formatted price according to CurrencyFormatString defined for currencyObj parameter.
Public methodStatic memberGetFormattedPrice(Decimal, Int32, Boolean)
Returns HTML encoded (depends on encode parameter) and formatted price according to CurrencyFormatString defined for specified site main currency.
Protected methodGetFormattedPriceInternal(Decimal, CurrencyInfo, Boolean)
Returns formatted price according to formatting string of the specified currency.
Protected methodGetFormattedPriceInternal(Decimal, Int32, Boolean)
Returns formatted price according to formatting string of the specified site main currency.
Public methodStatic memberGetFormattedValue
Returns formatted price according to CurrencyRoundTo.
Protected methodGetFormattedValueInternal
Returns formatted price, by default formatting string "{0:0.00}" is used.
Protected methodGetInfoByCodeName(String, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Boolean, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeName(String, Int32, Int32, Boolean)
Gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByCodeNameAsync(String, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given code name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByFullName
Gets an instance of info object based on the given full name.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Boolean)
Gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuid(Guid, Int32, Boolean)
Gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the given GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByGuidAsync(Guid, Int32, Boolean, CancellationToken)
Asynchronously gets an instance of info object based on the GUID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoById
Gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfoByIdAsync
Asynchronously gets an instance of info object based on ID.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetInfosByIds
Gets the list of info objects by their IDs.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberGetMainCurrency
Returns main currency of the specified site.
Public methodStatic memberGetMainCurrencyCode
Returns code of main currency for given site. Returns empty string when not found.
Protected methodGetMainCurrencyCodeInternal
Returns main currency code for given site or empty string when not found.
Protected methodGetMainCurrencyInternal
Returns main currency of specified site.
Protected methodGetObjectQuery
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodGetObjectQueryInternal
Gets the object query for the provider
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodStatic memberGetRelativelyFormattedPrice(Decimal, CurrencyInfo, Boolean)
Returns HTML encoded (depends on encode parameter) and relatively formatted price according to CurrencyFormatString defined for currencyObj parameter.
Public methodStatic memberGetRelativelyFormattedPrice(Decimal, Int32, Boolean)
Returns HTML encoded (depends on encode parameter) and relatively formatted price according to CurrencyFormatString defined for specified site main currency.
Protected methodGetRelativelyFormattedPriceInternal(Decimal, CurrencyInfo, Boolean)
Returns relatively formatted price according to formatting string of the specified currency.
Protected methodGetRelativelyFormattedPriceInternal(Decimal, Int32, Boolean)
Returns relatively formatted price according to formatting string of the specified site main currency.
Protected methodInit
Initializes the provider with the given type info and hashtable settings
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitHashtableSettings
Initializes the HashtableSettings based on typeInfo and using settings as default values.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodInitTypeInfoAndRegister
Initializes the provider variables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodInvalidate
Sets this provider as invalid
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberIsCurrencyWithExchangeRate
Returns true if site specified by its ID has defined exchange rate to given currency. Only enabled currencies are searched.
Protected methodIsCurrencyWithExchangeRateInternal
Returns true if site specified by its ID has defined exchange rate to given currency. Only enabled currencies are searched.
Protected methodLoadAllInfos
Loads all infos to the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodLoadInfos
Loads all objects from the database to memory.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodProcessWebFarmTask
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodProcessWebFarmTaskInternal
Runs the processing of specific web farm task for current provider
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRegisterObjectInHashtables
Registers the object instance within the hashtables.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodRemoveOriginalCodeNameFromHashtable
Removes the original object code name from the hashtable
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodSet
Inserts or updates the info object in the underlying data store.
(Inherited from AbstractInfoProviderTInfo, TProvider.)
Public methodSetAsDefaultProvider

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 AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodStatic memberSetCurrencyInfo Obsolete.
Sets (updates or inserts) specified currency.
Protected methodSetInfo
Inserts or Updates the object to the database.
(Overrides AbstractInfoProviderTInfo, TProvider, TQuerySetInfo(TInfo).)
Protected methodUpdateData(String, QueryDataParameters, String)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateData(IWhereCondition, IEnumerableKeyValuePairString, Object, Boolean)
Updates the data in the database based on the given where condition.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Protected methodUpdateObjectInHashtables
Updates the object instance in the hashtables. Update is different than RegisterObjectInHashtables(TInfo), because it logs task about changing object.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Public methodValidateCodeName
Validates the object code name. Returns true if the code name is valid.
(Inherited from AbstractInfoProviderTInfo, TProvider, TQuery.)
Top
See Also