Click or drag to resize
ShoppingCartInfo Class
ShoppingCartInfo data container class.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractObject
    CMS.DataEngineBaseInfo
      CMS.DataEngineAbstractInfoBaseShoppingCartInfo
        CMS.DataEngineAbstractInfoShoppingCartInfo
          CMS.EcommerceShoppingCartInfo

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 10.0.0
Syntax
C#
[SerializableAttribute]
public class ShoppingCartInfo : AbstractInfo<ShoppingCartInfo>

The ShoppingCartInfo type exposes the following members.

Constructors
  NameDescription
Public methodShoppingCartInfo
Constructor - Creates an empty ShoppingCartInfo object.
Public methodShoppingCartInfo(DataRow)
Constructor - Creates a new ShoppingCartInfo object from the given DataRow.
Protected methodShoppingCartInfo(SerializationInfo, StreamingContext)
Constructor for deserialization.
Top
Fields
  NameDescription
Protected fieldmDataClass
Data class with the SiteInfo data.
(Inherited from AbstractInfoBaseTInfo.)
Protected fieldmShoppingCartCustomData
Shopping cart custom data object
Protected fieldmStatus
Status of the object.
(Inherited from BaseInfo.)
Public fieldStatic memberNOT_KNOWN
Not known double constant.
Public fieldStatic memberNOT_KNOWN_DECIMAL
Unknown decimal constant.
Public fieldStatic memberNOT_KNOWN_INT
Not known integer constant.
Public fieldStatic memberOBJECT_TYPE
Object type
Public fieldStatic memberTYPEINFO
Type information.
Top
Properties
  NameDescription
Protected propertyAllowClone
Indicates if the object supports cloning.
(Inherited from BaseInfo.)
Public propertyAllowPartialUpdate
If true, the object allows partial updates.
(Inherited from AbstractInfoBaseTInfo.)
Protected propertyAllowRestore
Indicates if the object supports deleting to recycle bin.
(Inherited from BaseInfo.)
Protected propertyAllowTouchParent
Indicates if parent is allowed to be touched, if exists.
(Inherited from BaseInfo.)
Public propertyAssignedSites
Collection of the sites to which the object is associated via site bindings (M:N relationships).
(Inherited from BaseInfo.)
Public propertyBindings
Collection of the binding objects for the given object where the current object is a parent of the binding.
(Inherited from BaseInfo.)
Protected propertyCacheParentData
If true, the parent object data is cached within object.
(Inherited from BaseInfo.)
Public propertyCartContentItems
Subset of CartItem collection. Bundle items are excluded.
Public propertyCartDiscountsFilter
Filter to be used for filtering order discounts
Public propertyCartItems
List of shopping cart items.
Public propertyCartItemsMultiBuyDiscountNames
Dictionary with cart item id as key and list of his multi buy discount as value.
Public propertyCartProducts
Subset of CartItem collection. Bundle items and product options are excluded.
Public propertyCatalogDiscounts
Returns list of all catalog discounts which may affect this shopping cart.
Public propertyCatalogDiscountsFilter
Filter to be used for filtering discounts
Public propertyClassName
Returns the class name of this object
(Inherited from AbstractInfoBaseTInfo.)
Protected propertyClearCacheMethods
Dictionary with the methods for clearing the internal object cache [columnName] => [clearCacheAction]
(Inherited from AbstractInfoBaseTInfo.)
Protected propertyCodeNameColumn
Code name column name of the info record.
(Inherited from BaseInfo.)
Protected propertyCodeNameChanged
Returns whether the object code name changed or not
(Inherited from AbstractInfoBaseTInfo.)
Public propertyColumnNames
Column names.
(Inherited from AbstractInfoBaseTInfo.)
Public propertyContentTable
Table with the shopping cart items.
Public propertyContentTaxes
Taxes which should be applied to the shopping cart items.
Public propertyContentTaxesTable
Table with the summary of the taxes which were applied to the shopping cart items.
Public propertyCountryID
Country ID.
Public propertyCurrency
Selected currency.
Public propertyCustomer
Customer information.
Protected propertyCustomizedColumns
Gets the list of customized columns in current object
(Inherited from BaseInfo.)
Protected propertyDataClass
Data class with the info object data.
(Inherited from AbstractInfoBaseTInfo.)
Protected propertyDeleteFiles
Indicates if all physical files should be deleted when object will be deleted.
(Inherited from AbstractInfoBaseTInfo.)
Public propertyDiscountCoupon
Discount coupon information. It is null if no discount coupon is used.
Public propertyDiscounts
Returns list of all general discounts which may affect this shopping cart.
Protected propertyDisplayNameColumn
Display name column name of the info record.
(Inherited from BaseInfo.)
Public propertyExchangeRate
Exchange rate from site main currency to shopping cart currency. This exchange rate is applied to all site items (products, discounts, taxes, shipping option) which are present in the shopping cart to express their price in shopping cart currency.
Public propertyExchangeRateForGlobalItems
Exchange rate from global main currency to shopping cart currency. This exchange rate is applied to all global items (products, discounts, taxes, shipping option) which are present in the shopping cart to express their price in shopping curt currency. If site uses global currencies, it is equal to exchange rate from site main currency to shopping cart currency.
Public propertyExchangeRateToMainCurrency
Exchange rate from global main currency to site main currency. This exchange rate is applied to all global items (products, discounts, taxes, shipping option) which are present in the shopping cart to express their price in site main currency. If site uses global currencies, it is equal to 1.
Public propertyGeneralized
Generalized interface of this object.
(Inherited from AbstractInfoBaseTInfo.)
Public propertyHasAppliedCoupon
Indicates if shopping cart has applied coupon code
Protected propertyHasData
Returns true if the object has it's data storage initialized already
(Inherited from AbstractInfoBaseTInfo.)
Public propertyHasChanged
Returns true if the object changed.
(Inherited from AbstractInfoBaseTInfo.)
Public propertyHasUsableCoupon
Indicates if shopping cart has relevant coupon code.
Public propertyCheckAvailableItems
Indicates whether shopping cart items should be checked for availability.
Protected propertyCheckUnique
If true, the code name is checked for uniqueness upon saving.
(Inherited from BaseInfo.)
Protected propertyChildDependencies
Collection of the child dependencies for the given object. These are objects which should be included into the parent data (for example class data for BizForms), but aren't direct child of the object.
(Inherited from BaseInfo.)
Public propertyChildren
Collection of the child objects for the given object.
(Inherited from BaseInfo.)
Public propertyIcon
Object icon
(Inherited from BaseInfo.)
Protected propertyIgnoreExternalColumns
If true, externally stored columns are ignored and are stored normally in DB.
(Inherited from BaseInfo.)
Protected propertyInstanceGUID
Returns the object instance GUID
(Inherited from BaseInfo.)
Public propertyInvalidationEnabled
By default is invalidation enabled. If FALSE, invalidation of shopping cart item is disabled
Protected propertyIsCachedObject
If true, the object is cached within the system for later use
(Inherited from BaseInfo.)
Protected propertyIsClone
Indicates if the object is clone.
(Inherited from BaseInfo.)
Public propertyIsComplete
Returns true if the object is complete (has all columns).
(Inherited from AbstractInfoBaseTInfo.)
Public propertyIsCreatedFromOrder
Indicates if shopping cart object is created from order. It is set automatically when shopping cart object is created by GetShoppingCartInfoFromOrder method.
Protected propertyIsDisconnected
Returns true if this collection is disconnected from the database
(Inherited from BaseInfo.)
Public propertyIsDiscountApplied
Gets a value indicating whether is some discount applied to cart.
Public propertyIsDiscountCouponApplied
TRUE - discount coupon is applied at least to one shopping cart item, otherwise FALSE.
Public propertyIsEmpty
Indicates that shopping cart has no items (CartItems collection is empty).
Public propertyIsGlobal
Returns true if the object is global object. False if the object belongs to specific site only.
(Inherited from BaseInfo.)
Protected propertyIsCheckedOut
Indicates if the object is checked out.
(Inherited from BaseInfo.)
Protected propertyIsCheckedOutByUserID
Gets ID of the user who checked the object out.
(Inherited from BaseInfo.)
Public propertyIsItemDiscountApplied
TRUE - some discount is applied at least to one shopping cart item, FALSE - no discount is applied to shopping cart items. Discount data are calculated on the fly in case order item discount is not stored in the database.
Protected propertyIsObjectValid
Returns true if the object is considered valid.
(Inherited from BaseInfo.)
Public propertyIsShippingNeeded
Indicates if shipping is needed for a shopping cart.
Public propertyItem
Gets or sets the value of the column.
(Inherited from BaseInfo.)
Public propertyItemsDiscount
Catalog discount which is applied to the items total price. It is in shopping cart currency.
Public propertyItemsDiscountInMainCurrency
Catalog discount which is applied to the items total price. It is in site main currency.
Protected propertyLogEvents
If true, Events tasks are logged on the object update.
(Inherited from BaseInfo.)
Protected propertyLogExport
If true, export tasks are logged on the object update.
(Inherited from BaseInfo.)
Protected propertyLogIntegration
If true, integration tasks are being logged.
(Inherited from BaseInfo.)
Protected propertyLogSynchronization
Indicates how should be handled the logging of synchronization tasks on the object update.
(Inherited from BaseInfo.)
Protected propertyLogWebFarmTasks
If true, web farm tasks are logged on the object update.
(Inherited from BaseInfo.)
Public propertyMetaFiles
Collection of the metafiles belonging to the object.
(Inherited from BaseInfo.)
Protected propertyName
Returns the code name of the object
(Inherited from BaseInfo.)
Protected propertyObjectCategory
Object category.
(Inherited from BaseInfo.)
Protected propertyObjectCodeName
Object code name.
(Inherited from BaseInfo.)
Protected propertyObjectDisplayName
Object display name.
(Inherited from BaseInfo.)
Protected propertyObjectFullName
Object full name if exists
(Inherited from BaseInfo.)
Protected propertyObjectGroupID
Object community group ID.
(Inherited from BaseInfo.)
Protected propertyObjectGUID
Object GUID.
(Inherited from BaseInfo.)
Protected propertyObjectIcon
Object icon metafile.
(Inherited from BaseInfo.)
Protected propertyObjectIconGUID
Object icon GUID.
(Inherited from BaseInfo.)
Protected propertyObjectID
Object ID.
(Inherited from BaseInfo.)
Protected propertyObjectIsCustom
Indicates if object is custom.
(Inherited from BaseInfo.)
Protected propertyObjectIsCustomized
Indicates if object is customized.
(Inherited from BaseInfo.)
Protected propertyObjectLastModified
Last modified time.
(Inherited from BaseInfo.)
Protected propertyObjectOrder
Returns the order of the object among the other objects.
(Inherited from BaseInfo.)
Protected propertyObjectParent
Object parent.
(Inherited from BaseInfo.)
Protected propertyObjectParentID
Object parent ID.
(Inherited from BaseInfo.)
Public propertyObjectSettings
Object settings
(Inherited from BaseInfo.)
Protected propertyObjectSite
Returns the object site.
(Inherited from BaseInfo.)
Protected propertyObjectSiteID
Object site ID.
(Inherited from BaseInfo.)
Protected propertyObjectSiteName
Object site name.
(Inherited from BaseInfo.)
Protected propertyObjectStatus
Returns the current status of the object.
(Inherited from BaseInfo.)
Protected propertyObjectThumbnail
Object thumbnail metafile.
(Inherited from BaseInfo.)
Protected propertyObjectThumbnailGUID
Object thumbnail GUID.
(Inherited from BaseInfo.)
Protected propertyObjectVersionGUID
Object version GUID.
(Inherited from BaseInfo.)
Public propertyOrder
Order data. Loaded when the shopping cart is created from an existing order, otherwise it is null.
Public propertyOrderDiscount
Discount which is applied to the items total price. It is in shopping cart currency.
Public propertyOrderDiscountInMainCurrency
Discount which is applied to the items total price. It is in site main currency.
Public propertyOrderDiscounts
Returns list of all discounts which may affect total price of this shopping cart and not price of individual items.
Public propertyOrderId
ID of the order to which the shopping cart belongs or from which the shopping cart was created.
Public propertyOrderRelatedDiscountSummaryItems
List of order and multibuy discounts presentation data related to current shopping cart.
Protected propertyOriginalObjectCodeName
Returns the original object code name
(Inherited from AbstractInfoBaseTInfo.)
Public propertyOtherBindings
Collection of the binding objects for the given object where the current object is not a parent of the binding (parent object is on the second side).
(Inherited from BaseInfo.)
Public propertyParent
Object parent
(Inherited from BaseInfo.)
Protected propertyParentObjectType
Parent object type.
(Inherited from BaseInfo.)
Public propertyPaymentGatewayCustomData
Payment gateway custom data.
Public propertyPaymentOption
Selected payment method. If none is selected and there is only one available, it is selected automatically.
Public propertyPriceCalculatedOnTheFly
Indicates if shopping cart item data calculated on the fly, default value is TRUE.
Protected propertyPrioritizedProperties
Gets the list of properties which should be prioritized in the macro controls (IntelliSense, MacroTree).
(Inherited from BaseInfo.)
Public propertyPrivateDataCleared
Indicates if private data were cleared from this shopping cart object. It is set automatically when shopping cart private data are cleared by ClearShoppingCartPrivateData method.
Public propertyProcesses
Collection of the processes belonging to the object.
(Inherited from BaseInfo.)
Public propertyProperties
Properties of the object
(Inherited from AbstractInfoBaseTInfo.)
Protected propertyReferringObjects
Collection of the objects depending on this object (object which have FK to this object).
(Inherited from BaseInfo.)
Public propertyRegisterAfterCheckout
Indicates that customer will be registered after checkout.
Public propertyRegisterAfterCheckoutTemplate
E-mail template code name used for registration after checkout.
Protected propertyRegisteredProperties
Registered properties
(Inherited from AbstractInfoBaseTInfo.)
Public propertyRelatedData
Custom data connected to the object.
(Inherited from BaseInfo.)
Public propertyRoundedTotalPrice
Rounded total price in shopping cart currency. It is rounded according to the shopping cart currency rules.
Public propertyRoundedTotalPriceInMainCurrency
Rounded total price in site main currency. It is rounded according to the site main currency rules.
Public propertySearchType
Gets the search type name.
(Inherited from AbstractInfoBaseTInfo.)
Public propertyShipping
Shipping cost without taxes. Shipping free limit is applied. Value is in shopping cart currency.
Public propertyShippingDiscount
Shipping discount which is applied to the items total price. It is in shopping cart currency.
Public propertyShippingDiscountInMainCurrency
Shipping discount which is applied to the items total price. It is in site main currency.
Public propertyShippingDiscounts
Returns list of all discounts which may affect total shipping price of this shopping cart.
Public propertyShippingInMainCurrency
Shipping cost without taxes. Shipping free limit is applied. Value is in site main currency.
Public propertyShippingOption
Selected shipping option. If none is selected and there is only one available, it is selected automatically.
Public propertyShippingTaxes
Taxes which should be applied to the selected shipping option.
Public propertyShippingTaxesTable
Table with the summary of the taxes which were applied to the selected shipping option.
Public propertyShoppingCartBillingAddress
Gets or sets the current billing address.
Protected propertyShoppingCartBillingAddressID
Shopping cart billing address ID.
Public propertyShoppingCartCompanyAddress
Gets or sets the current company address.
Protected propertyShoppingCartCompanyAddressID
Shopping cart company address ID.
Public propertyShoppingCartContactID
Shopping cart contact ID.
Public propertyShoppingCartCouponCode
Code of coupon used during shopping.
Public propertyShoppingCartCulture
Shopping cart order culture (or culture of the order user created using the shopping cart).
Public propertyShoppingCartCurrencyID
Shopping cart currency ID.
Public propertyShoppingCartCustomData
Shopping cart custom data.
Public propertyShoppingCartCustomerID
Shopping cart customer ID.
Public propertyShoppingCartDiscountCouponID
Shopping cart discount coupon ID.
Public propertyShoppingCartGUID
Shopping cart GUID.
Public propertyShoppingCartID
Shopping cart ID.
Public propertyShoppingCartLastUpdate
Date and time when the shopping cart was last updated.
Public propertyShoppingCartNote
Shopping cart note.
Public propertyShoppingCartPaymentOptionID
Shopping cart payment option ID.
Public propertyShoppingCartShippingAddress
Gets or sets the current shipping address.
Protected propertyShoppingCartShippingAddressID
Shopping cart shipping address ID.
Public propertyShoppingCartShippingOptionID
Shopping cart shipping option ID.
Public propertyShoppingCartSiteID
Shopping cart site ID.
Public propertyShoppingCartUserID
ID of the registered user the shopping cart belongs to.
Public propertyScheduledTasks
Collection of the scheduled tasks belonging to the object.
(Inherited from BaseInfo.)
Public propertySite
Object site
(Inherited from BaseInfo.)
Public propertySiteName
Name of the site to which the shopping cart belongs.
Public propertyStateID
State ID.
Protected propertySupportsVersioning
Indicates if the object versioning is supported. Default false
(Inherited from BaseInfo.)
Public propertyTaxSummary
DataRowCollection with the summary of the taxes, used as property for MacroDataSource.
Public propertyThumbnail
Object thumbnail
(Inherited from BaseInfo.)
Public propertyTotalItemsPrice
Total price of all shopping cart items in shopping cart currency. Items discounts and taxes are included.
Public propertyTotalItemsPriceInMainCurrency
Total price of all shopping cart items in site main currency. Items discounts and taxes are included.
Public propertyTotalItemsTax
Total tax of all shopping cart items in shopping cart currency.
Public propertyTotalItemsTaxInMainCurrency
Total tax of all shopping cart items in site main currency.
Public propertyTotalItemsWeight
Total weight of shopping cart items.
Public propertyTotalPrice
Total price of the shopping cart in shopping cart currency. All discounts, taxes and shipping are included.
Public propertyTotalPriceInMainCurrency
Total price of the shopping cart in site main currency. All discounts, taxes and shipping are included.
Public propertyTotalShipping
Total shipping in shopping cart currency. Shipping taxes are included.
Public propertyTotalShippingInMainCurrency
Total shipping in site main currency. Shipping taxes are included.
Public propertyTotalTax
Total tax which is applied to all shopping cart items altogether. It is in shopping cart currency.
Public propertyTotalTaxInMainCurrency
Total tax which is applied to all shopping cart items altogether. It is in site main currency.
Public propertyTotalUnits
Sum of all shopping cart items' units, bundle items and product options are not included.
Protected propertyTouchCacheDependencies
If true, cache dependencies are touched when the object is changed.
(Inherited from BaseInfo.)
Public propertyTypeInfo
Object type information.
(Inherited from BaseInfo.)
Protected propertyUpdateTimeStamp
If true, timestamp of the object is updated when saved.
(Inherited from BaseInfo.)
Protected propertyUpdateVersionGUID
If true, version GUID of the object is updated when saved.
(Inherited from AbstractInfoBaseTInfo.)
Public propertyUser
Owner of the shopping cart. It is null if customer is anonymous or public.
Protected propertyValidateCodeName
If true, the code name is validated upon saving.
(Inherited from BaseInfo.)
Protected propertyVersioningEnabled
Indicates if the object versioning is enabled by the settings.
(Inherited from BaseInfo.)
Top
Methods
  NameDescription
Protected methodAddColumnPrefixesWhereCondition
Adds restriction to given where filtering out all rows where given column starts with one of excluded prefixes found in TypeInfo default data settings.
(Inherited from BaseInfo.)
Protected methodAllowExternalColumn
Indicates whether a given column is allowed to be saved externally.
(Inherited from AbstractInfoBaseTInfo.)
Public methodAnyItemChanged
Returns true if any of specified columns changed.
(Inherited from AbstractInfoBaseTInfo.)
Public methodApplyExchangeRate(Double)
Returns price in shopping cart currency.
Public methodApplyExchangeRate(Double, Boolean)
Returns price in shopping cart currency.
Public methodApplyExchangeRateFromGlobalMainCurrency
Returns price in main currency of the site the shopping cart belongs to.
Protected methodBuildObjectPath
Builds the path from the given column.
(Inherited from BaseInfo.)
Public methodCalculateRemainingAmountForFreeShipping
Returns remaining amount for free shipping. Method returns 0 if the cart is null or if there is no valid discount or if free shipping is already applied.
Protected methodClearCache
Clears the nested cached objects
(Inherited from BaseInfo.)
Protected methodClearCachedValues
Clears the cached values depending on the given column value.
(Inherited from BaseInfo.)
Public methodClearData
Clears data from the object.
(Inherited from BaseInfo.)
Public methodClone
Creates a clone of the object
(Inherited from AbstractInfoBaseTInfo.)
Public methodClone(Boolean)
Creates a clone of the object
(Inherited from AbstractInfoBaseTInfo.)
Public methodCloneObject
Creates the clone of the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodColumnsChanged
Returns true if at least one column of the column list provided as the first argument was changed.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodCombineColumnNames(ICollection)
Combines column names from supplied collections into a list and caches it in mCombinedColumnNames. Does nothing when column names are already cached unless TypeInfo has ColumnsInvalidated set to true. Returns combined column names.
(Inherited from AbstractInfoBaseTInfo.)
Public methodCombineColumnNames(String)
Combines supplied column names into a list and caches it in mCombinedColumnNames. Does nothing when column names are already cached unless TypeInfo has ColumnsInvalidated set to true. Returns combined column names.
(Inherited from AbstractInfoBaseTInfo.)
Public methodCompareTo
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from BaseInfo.)
Public methodContainsColumn
Returns true if the object contains given column.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodCopyExternalColumns
Copy value of external columns directly via set value
(Inherited from BaseInfo.)
Protected methodCopyMemoryProperties
Copies memory properties
(Inherited from BaseInfo.)
Protected methodCopyProperties
Copies memory properties
(Inherited from AbstractInfoBaseTInfo.)
Public methodDataChanged
Returns true if the object changed.
(Inherited from AbstractInfoBaseTInfo.)
Public methodDelete
Deletes the object using appropriate provider
(Inherited from BaseInfo.)
Protected methodDeleteData
Deletes the object.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteDataInternal
Deletes the object data from the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteExternalColumns
Goes through the columns which are stored externally and deletes all the files.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteMetafiles
Deletes the metafiles related to this object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodDeleteObject
Deletes the object using appropriate provider.
(Overrides AbstractInfoBaseTInfoDeleteObject.)
Public methodDestroy
Destroys the object including its version history using appropriate provider
(Inherited from BaseInfo.)
Protected methodDisconnect
Disconnects the collection from the database.
(Inherited from BaseInfo.)
Protected methodEnsureBinaryData
Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
(Inherited from BaseInfo.)
Protected methodEnsureBinaryData(Boolean)
Makes sure that the binary data is loaded into binary column of the object.
(Inherited from BaseInfo.)
Protected methodEnsureCodeName
Ensures the code name of the object if not set
(Inherited from BaseInfo.)
Protected methodEnsureData
Creates a new data class container within the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodEnsureGUID
Ensures the GUID of the object
(Inherited from BaseInfo.)
Protected methodEnsureHierarchyColumns
Ensures the IDPath and Level columns.
(Inherited from BaseInfo.)
Protected methodEnsureLastModified
Ensures the last modified time stamp of the object
(Inherited from BaseInfo.)
Protected methodEnsureUniqueCodeName
Ensures that the object has a unique code name within it's context
(Inherited from BaseInfo.)
Public methodExecuteWithOriginalData
Executes the given action using original data of the object.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodExportDefaultData
Exports the default object installation data
(Inherited from BaseInfo.)
Protected methodFinalize
Destructor
(Inherited from BaseInfo.)
Public methodGetApplicableCatalogDiscounts
Returns subset of CatalogDiscounts which are to be applied to given product.
Public methodGetApplicableOrderDiscounts
Returns subset of OrderDiscounts which are to be applied to this shopping cart.
Public methodGetApplicableShippingDiscounts
Returns subset of ShippingDiscounts which are to be applied to shipping of this shopping cart.
Protected methodGetAutomaticCodeName
Gets the automatic code name for the object
(Inherited from BaseInfo.)
Protected methodGetAutomaticProperty
Tries to get the automatic property value for underlying object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetBinaryData
Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
(Inherited from BaseInfo.)
Public methodGetBooleanValue
Gets the boolean value from the object.
(Inherited from BaseInfo.)
Protected methodGetColumnNames
Gets the default list of column names for this class
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetCount
Gets count of the objects filtered by given where condition.
(Inherited from BaseInfo.)
Protected methodGetCurrentObjectPathPart
Builds the path from the given column.
(Inherited from BaseInfo.)
Protected methodGetCustomProperties
Gets list of custom properties.
(Inherited from BaseInfo.)
Protected methodGetData
Returns the data according to the set of input parameters.
(Inherited from BaseInfo.)
Protected methodGetDataQueryInternal
Gets the data query for this object type
(Inherited from BaseInfo.)
Public methodGetDateTimeValue
Gets the DateTime value from the object.
(Inherited from BaseInfo.)
Protected methodGetDefaultData
Returns the default object installation data
(Inherited from BaseInfo.)
Protected methodGetDefaultDataExportColumns
Returns names of all columns that should be exported with default data as a comma separated string.
(Inherited from BaseInfo.)
Protected methodGetDefaultDataWhereCondition
Gets the where condition to filter out the default installation data
(Inherited from BaseInfo.)
Protected methodGetDefaultObject
Returns default object of given object type. Has to be overridden in specific info. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
(Inherited from BaseInfo.)
Protected methodGetDependenciesNames
Returns a list of object names which depend on this object. First tries to execute checkdependencies query, if not found, an automatic process is executed.
(Inherited from BaseInfo.)
Protected methodGetDependenciesNamesAuto
Returns a list of object names which depend on this object.
(Inherited from BaseInfo.)
Protected methodGetDependencyCacheKeys
Gets collection of dependency keys to be touched when modifying the current object.
(Inherited from BaseInfo.)
Public methodGetDependencyObjectType
Gets dependency object type
(Inherited from BaseInfo.)
Public methodGetDoubleValue
Gets the double value from the object.
(Inherited from BaseInfo.)
Protected methodGetEditingPageURL
Gets the object editing page URL.
(Inherited from BaseInfo.)
Protected methodGetExisting
Returns the existing object based on current object data.
(Inherited from BaseInfo.)
Protected methodGetExistingBase
Returns single info object and ensures correct GUID vs. code name priority is used (if applicable) after resolving provided whereCondition.

If no object match provided whereCondition, null is returned.

(Inherited from BaseInfo.)
Protected methodGetExistingWhereCondition
Gets a where condition to find an existing object based on current object
(Inherited from BaseInfo.)
Protected methodGetExistingWhereCondition(Boolean)
Gets a where condition to find an existing object based on current object
(Inherited from BaseInfo.)
Protected methodGetExternalColumnData
Returns the column data from external storage if exists.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalColumns
Returns the list of columns registered as the external columns.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalColumnSettings
Returns settings for external storage of the column. Returns null by default (which causes the default settings to be used in the external column data storage process).
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalFiles
Goes through the columns which are stored externally and returns the list of particular files this object uses.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetExternalPath
Returns path to the external storage with data of the given column. If the column data is not stored in the external storage (not enabled), and the check for enabled is allowed, returns null.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetFileInfo
Returns FileInfo object from external storage if exists.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetFormattedPrice(Double)
Returns formatted price using the shopping cart currency formatting string.
Public methodGetFormattedPrice(Double, Boolean)
Returns formatted price using the shopping cart currency formatting string.
Protected methodGetFullObjectName
Returns the name of the object within its parent hierarchy.
(Inherited from BaseInfo.)
Protected methodGetGeneralizedInfo
Gets the generalized info for this object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetGlobalPermissionName
Returns name of the global permission name corresponding to the given permission name. By default, "Global" + permissionName is returned.
(Inherited from BaseInfo.)
Protected methodGetGroupWhereCondition
Gets the group where condition for the object
(Inherited from BaseInfo.)
Public methodGetGuidValue
Gets the guid value from the object.
(Inherited from BaseInfo.)
Protected methodGetChildDependencies
Gets the child dependencies repository
(Inherited from BaseInfo.)
Protected methodGetChildWhereCondition
Gets the child object where condition.
(Inherited from BaseInfo.)
Protected methodGetIconUrl
Gets the object icon URL
(Inherited from BaseInfo.)
Protected methodGetIDPathPartLength
Returns the length of a part of IDPath.
(Inherited from BaseInfo.)
Public methodGetIntegerValue
Gets the integer value from the object.
(Inherited from BaseInfo.)
Protected methodGetLastObjectOrder
Returns number which will be the last order within all the other items (according to Parent, Group and Site settings). I.e. returns largest existing order + 1.
(Inherited from BaseInfo.)
Protected methodGetLocalColumnNames
Gets the list of local column names for particular object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetLocalProperties
Gets the list of local properties for particular object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetLockObject
Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
(Inherited from BaseInfo.)
Protected methodGetModifiedFrom
Gets the DataSet of all the objects modified from specified date.
(Inherited from BaseInfo.)
Protected methodGetNameCollisions
Gets the list of the name collisions of the given object
(Inherited from BaseInfo.)
Protected methodGetNamePathPartColumn
Returns the name of the column which is used to build the NamePath
(Inherited from BaseInfo.)
Public methodGetObject(Int32)
Gets the object by its ID.
(Inherited from BaseInfo.)
Protected methodGetObject(IWhereCondition, Boolean)
Gets the object by specified where condition.
(Inherited from BaseInfo.)
Public methodGetObjectData
Gets object data.
(Overrides AbstractInfoBaseTInfoGetObjectData(SerializationInfo, StreamingContext).)
Protected methodGetObjectChildren
Gets the object children repository
(Inherited from BaseInfo.)
Protected methodGetObjectIdentifier
Gets the object identifier that uniquely identifies the object
(Inherited from BaseInfo.)
Protected methodGetObjectKey
Gets the unique string key for the object.
(Inherited from BaseInfo.)
Protected methodGetObjectName
Returns object name combining object type name and object display name.
(Inherited from BaseInfo.)
Protected methodGetObjectOrderID
Returns ID of the item being ordered. By default return ObjectID. This is overridden in TreeNode, where NodeID has to be supplied.
(Inherited from BaseInfo.)
Protected methodGetObjectTypeForColumn
Gets the object type for the given column or null if the object type is not found or unknown.
(Inherited from BaseInfo.)
Protected methodGetOrderIdentityWhereCondition
Gets order identity where condition to identify the object to be ordered
(Inherited from BaseInfo.)
Protected methodGetOrderQueryParameters
Creates QueryDataParameters with special macros for object order management.
(Inherited from BaseInfo.)
Public methodGetOriginalValue
Returns the original value of column.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetOtherBindings
Gets the repository of other bindings
(Inherited from BaseInfo.)
Protected methodGetParent
Returns the parent object.
(Inherited from BaseInfo.)
Protected methodGetPermissionName
Converts PermissionEnum to permission codename which will be checked when CheckPermission() is called. Derived classes can override this method to change permission which is checked (for example check for global permissions if object is global).
(Inherited from BaseInfo.)
Protected methodGetPermissionObjectType
Returns the permission object type of the object (checks the SiteID column and SiteBinding columns). According to this value, the permission check is performed.
(Inherited from BaseInfo.)
Protected methodGetPermissionToCheck
Gets permission to check for the object. By default the Create and Delete permission is changed to Modify.
(Inherited from BaseInfo.)
Protected methodGetPhysicalFiles
Gets DataSet with physical files.
(Inherited from BaseInfo.)
Public methodGetProperty
Gets the property value.
(Inherited from BaseInfo.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetReferringObjects
Gets the repository of depending objects
(Inherited from BaseInfo.)
Protected methodGetRegisteredProperties
Gets list of registered properties.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetSearchDocument
Returns index document for current object with dependencies on search index info.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetSearchFields
Returns search fields collection. When existing collection is passed as argument, fields will be added to that collection. When collection is not passed, new collection will be created and return. Collection will contain field values only when collection with StoreValues property set to true is passed to the method. When method creates new collection, it is created with StoreValues property set to false.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetSearchID
Gets the id column value which is used as search id by default.
(Inherited from BaseInfo.)
Public methodGetSearchImageUrl
Returns URL to current search result item.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetShoppingCartItem(Guid)
Returns shopping cart item from the shopping cart object.
Public methodGetShoppingCartItem(Int32)
Returns shopping cart item from the shopping cart object.
Protected methodGetSiblingsQueryInternal
Gets the parameterized query to get siblings of the object (If there is no parent-child hierarchy, query is parameterized for all objects)
(Inherited from BaseInfo.)
Protected methodGetSiblingsWhereCondition
Creates where condition according to Parent, Group and Site settings.
(Inherited from BaseInfo.)
Protected methodGetSiteWhereCondition
Gets the site where condition for the object
(Inherited from BaseInfo.)
Public methodGetStringValue
Gets the string value from the object.
(Inherited from BaseInfo.)
Protected methodGetSynchronizedColumns
Gets the list of synchronized columns for this object.
(Inherited from BaseInfo.)
Protected methodGetThumbnailUrl
Gets the object thumbnail URL
(Inherited from BaseInfo.)
Protected methodGetUniqueCodeName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.)
Protected methodGetUniqueDisplayName
Returns the unique display name for the specified object.
(Inherited from BaseInfo.)
Protected methodGetUniqueName
Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
(Inherited from BaseInfo.)
Protected methodGetUniqueNameWhereCondition
Constructs base where condition for checking column value uniqueness. This method can be overridden in child classes to add more conditions.
(Inherited from BaseInfo.)
Public methodGetValue(String)
Gets the field value.
(Inherited from AbstractInfoBaseTInfo.)
Public methodGetValueT(String, T)
Gets the field value converted to a specified type.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodGetValueForTranslation
Returns value for translation services. Returns unmodified field content by default.
(Inherited from BaseInfo.)
Protected methodGetVirtualFileRelativePath
Returns virtual relative path for specific column Ensures the GUID of the object
(Inherited from BaseInfo.)
Protected methodHasAutomaticProperty
Returns true if the given column provides an automatic property to access it's binding.
(Inherited from AbstractInfoBaseTInfo.)
Public methodChangedColumns
Returns list of column names which values were changed.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodCheckDefaultPermissions
Check universal permissions for an object
(Inherited from BaseInfo.)
Protected methodCheckDependencies
Checks object for dependent objects. Returns true if there is at least one dependent object. First tries to execute checkdependencies query, if not found, an automatic process is executed.
(Inherited from BaseInfo.)
Protected methodCheckLicense
Checks the object license. Returns true if the licensing conditions for this object were matched.
(Inherited from BaseInfo.)
Public methodCheckPermissions
Checks whether the specified user has permissions for this object.
(Inherited from BaseInfo.)
Protected methodCheckPermissionsInternal
Checks whether the specified user has permissions for this object. This method is called automatically after CheckPermissions event was fired.
(Inherited from BaseInfo.)
Protected methodCheckPermissionsWithHandler
Checks whether the specified user has permissions for this object. Outcome of this method is determined by combining results of CheckPermissions event and CheckPermissionsInternal method.
(Inherited from BaseInfo.)
Public methodCheckUniqueCodeName
Checks if the object has unique code name. Returns true if the object has unique code name.
(Inherited from BaseInfo.)
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 BaseInfo.)
Protected methodInitObjectsOrder
Inits the proper order of the sibling objects so the order column is consistent.
(Inherited from BaseInfo.)
Protected methodInitObjectsOrderPostprocessing
Method called after the InitObjectOrder method is called. Override this to do further actions after order initialization.
(Inherited from BaseInfo.)
Public methodInsert
Inserts the object using appropriate provider
(Inherited from BaseInfo.)
Protected methodInsertAsClone
Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
(Inherited from BaseInfo.)
Protected methodInsertAsCloneInternal
This method is called on cloned object prepared in memory by InsertAsClone method. Override if you need to do further actions before inserting actual object to DB (insert special objects, modify foreign keys, copy files, etc.). Calls Insert() by default.
(Inherited from BaseInfo.)
Protected methodInsertAsClonePostprocessing
This method is called once the object is completely cloned (with all children, bindings, etc.). Override if you need to do further actions after the object has been cloned.
(Inherited from BaseInfo.)
Protected methodInsertData
Inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodInsertDataInternal
Inserts the object data to the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodInvalidate
Invalidates the object in the object table.
(Inherited from BaseInfo.)
Public methodInvalidateCalculations
Invalidates all shopping cart calculations.
Public methodInvalidateDiscountFilter
Invalidates product discount filter.
Public methodInvalidateDiscounts
Invalidates cart content discounts.
Public methodInvalidateExchangeRate
Invalidates shopping cart exchange rates.
Protected methodIsAvailableOnSite
Checks whether info object as available on given site. Available means that object is global or assigned to given site.
(Inherited from BaseInfo.)
Protected methodIsCheckedOutByUser
Returns true if the object is checked out by the specified user.
(Inherited from BaseInfo.)
Protected methodIsChildOf
Returns true if the object is child of the given object. If parameter parent is null, returns true only if the object is not a child of any object.
(Inherited from BaseInfo.)
Protected methodIsModifiedExternally
Goes through the columns which are stored externally and checks if the data in DB is the same as in external storage. If all the columns are same returns true, otherwise false.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodIsObjectInvalid
Returns true if the object is invalid.
(Inherited from BaseInfo.)
Public methodItemChanged
Returns true if the item on specified column name changed.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodLoadData
Loads the object using the given settings
(Inherited from AbstractInfoBaseTInfo.)
Protected methodLoadDefaultData
Loads the default data to the object.
(Inherited from AbstractInfoBaseTInfo.)
Public methodMacroRepresentation
By default, BaseInfo has no special macro representation.
(Inherited from BaseInfo.)
Public methodMakeComplete
Makes the object data complete.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodNewObject
Creates new object of the given class based on the given settings
(Inherited from AbstractInfoTInfo.)
Protected methodPermissionCheckException
Fires an exception in case authorization result is false (denied or insignificant)
(Inherited from BaseInfo.)
Public methodPropertyPropertyType
Returns the extension property for the object
(Inherited from AbstractObject.)
Protected methodReconnect
Reconnects the collection to the database.
(Inherited from BaseInfo.)
Protected methodRegisterExternalColumn
Registers external column settings to the hash table.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRegisterExternalColumns
Registers external column settings to the hash table.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRegisterProperties
Register the custom properties
(Overrides AbstractInfoBaseTInfoRegisterProperties.)
Protected methodRegisterProperty(String, Object, FuncTInfo, Object, Object)
Registers the given parametrized property to the object.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRegisterPropertyTProperty(String, FuncTInfo, Object)
Registers the given property to the object
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRemoveObjectDependencies
Removes object dependencies. First tries to execute removedependencies query, if not found, automatic process is executed.
(Inherited from BaseInfo.)
Public methodRemoveShoppingCartItem(Guid)
Removes shopping cart item and its product options from the shopping cart object.
Public methodRemoveShoppingCartItem(Int32)
Removes shopping cart item and its product options from the shopping cart object.
Public methodResetChanges
Resets the object changes and keeps the new values as unchanged according to the asUnchanged parameter.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodRestoreSettings
Restores local settings for object instance.
(Inherited from BaseInfo.)
Public methodRevertChanges
Reverts the object changes to the original values.
(Inherited from AbstractInfoBaseTInfo.)
Public methodRoundTo
Returns rounded price using the shopping cart currency settings.
Protected methodSaveExternalColumns
Goes through the columns which are stored externally and ensures them in the external storage.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodSerializationNotSupported
Throws serialization not supported exception
(Inherited from BaseInfo.)
Protected methodSetData
Updates or inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodSetExternalColumnData
Saves the column data to the external storage if exists. Returns true if data was stored in external storage and should not be stored also in DB. If data should be stored in DB, returns false.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodSetObject
Updates the object using appropriate provider.
(Overrides AbstractInfoBaseTInfoSetObject.)
Protected methodSetObjectAlphabeticalOrder
Moves the object to the right position according to the custom order.
(Inherited from BaseInfo.)
Protected methodSetObjectOrder
Moves the object to the specified order. The move is done within the object's siblings.
(Inherited from BaseInfo.)
Protected methodSetObjectOrderPostprocessing
Method which is called after the order of the object was changed. Generates staging tasks and webfarm tasks by default.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodSetParent
Updates the parent object, enables to update the data that is overridden in the parent object before or after it is saved
(Inherited from BaseInfo.)
Protected methodSetReadOnly
Locks the object as a read-only
(Inherited from AbstractInfoBaseTInfo.)
Public methodSetShoppingCartItem
Adds the product (and its product options) specified in the itemParams. If such product configuration already exists in the shopping cart, only the CartItemUnits property is increased by Quantity. The added/updated shopping cart item is returned.
Public methodSetValue(String, Object)
Sets the field value.
(Inherited from AbstractInfoBaseTInfo.)
Public methodSetValue(String, Object, Boolean)
Sets the object value to the nullable column.
(Inherited from BaseInfo.)
Public methodSetValue(String, Object, Object)
Sets the object value to the nullable column.
(Inherited from BaseInfo.)
Protected methodSortAlphabetically
Sort objects alphabetically.
(Inherited from BaseInfo.)
Protected methodStoreSettings
Stores local settings for object instance.
(Inherited from BaseInfo.)
Public methodSubmitChanges
Submits the changes in the object to the database.
(Inherited from BaseInfo.)
Public methodToMacroString
Returns the default text representation in the macros.
(Inherited from BaseInfo.)
Public methodToString
Returns the text representation of the object
(Inherited from BaseInfo.)
Public methodTouchKeys
Touches the cache dependency keys of the object to flush the dependent cache items.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodTouchParent
Updates the parent object by saving it (to update the timestamp).
(Inherited from BaseInfo.)
Protected methodTryGetAutomaticProperty
Tries to get the automatic property value for underlying object
(Inherited from AbstractInfoBaseTInfo.)
Public methodTryGetProperty(String, Object)
Returns value of property.
(Inherited from AbstractInfoBaseTInfo.)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from BaseInfo.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractInfoBaseTInfo.)
Public methodUpdate
Updates the database entity using appropriate provider
(Inherited from BaseInfo.)
Protected methodUpdateData
Updates the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpdateDataInternal
Updates the object data to the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpdateExternalColumns
Goes through the columns which are stored externally and updates DB versions with the data from external storage.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpdateFromDB
Updates the data of the object from DB (updates also ObjectSettings).
(Inherited from BaseInfo.)
Protected methodUpdatePhysicalFiles
Saves physical files.
(Inherited from BaseInfo.)
Protected methodUpsertData
Updates or inserts the object to the database.
(Inherited from AbstractInfoBaseTInfo.)
Protected methodUpsertDataInternal
Upserts the data to the database
(Inherited from AbstractInfoBaseTInfo.)
Protected methodWriteDefaultData
Writes the default object installation data into xml file
(Inherited from BaseInfo.)
Top
Extension Methods
  NameDescription
Public Extension MethodCompare
Compares two BaseInfo objects (data & structure) according to comparison settings given.
(Defined by DataExtensions.)
Public Extension MethodSerialize
Returns object data serialized into the XML element.
(Defined by SerializationExtensions.)
Top
See Also