Click or drag to resize
ShoppingCartCheckResult Class

Note: This API is now obsolete.

Container for results of cart item checks.
Inheritance Hierarchy
SystemObject
  CMS.EcommerceShoppingCartCheckResult

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 12.0.0
Syntax
C#
[ObsoleteAttribute("Use ShoppingCartValidator instead.")]
public class ShoppingCartCheckResult

The ShoppingCartCheckResult type exposes the following members.

Constructors
  NameDescription
Public methodShoppingCartCheckResult
Top
Fields
  NameDescription
Protected fieldmItemResults
List of ShoppingCartItem check results.
Protected fieldmItemResultsBySKUID
Dictionary of ShoppingCartItem check results indexed by the ID of SKU.
Top
Properties
  NameDescription
Public propertyCheckFailed
Indicates whether check has failed (whole cart check has failed or at least one cart item check has failed).
Public propertyItemResults
Results for all products which have failed during check.
Protected propertyItemResultsBySKUID
Dictionary of ShoppingCartItem check results indexed by the ID of SKU.
Public propertyItemsCheckFailed
Indicates whether check has failed (at least one cart item check has failed).
Public propertyShippingOptionNotAvailable
Indicates that shipping option is not available for shopping cart.
Top
Methods
  NameDescription
Public methodAddCartItemResult
Adds specified item check result to this cart check result object.
Public methodGetFormattedMessage
Returns formatted error message when check has failed, meaning that errors from each item are on its own line using end-of-line char. Returns empty string if check passed.
Public methodGetHTMLFormattedMessage
Returns HTML formatted error message when check has failed, meaning that errors from each item are on its own line using [br /] HTML tag. Returns empty string if check passed.
Public methodGetMessage
Returns check result formatted as string. Message consists of common error message followed by individual item error messages separated using specified separators. Empty string is returned when no errors found.
Top
See Also