ShoppingCartCheckResult Class

Container for results of cart item checks.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.ShoppingCartCheckResult

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

Syntax

public class ShoppingCartCheckResult

The ShoppingCartCheckResult type exposes the following members.

Constructors

	Name	Description
Public method	ShoppingCartCheckResult

Methods

	Name	Description
Public method	AddCartItemResult	Adds specified item check result to this cart check result object.
Public method	GetFormattedMessage	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 method	GetHTMLFormattedMessage	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 method	GetMessage	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.

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	mItemResults	List of ShoppingCartItem check results.
Protected field	mItemResultsBySKUID	Dictionary of ShoppingCartItem check results indexed by the ID of SKU.

Properties

	Name	Description
Public property	CheckFailed	Indicates whether check has failed (whole cart check has failed or at least one cart item check has failed).
Public property	ItemResults	Results for all products which have failed during check.
Protected property	ItemResultsBySKUID	Dictionary of ShoppingCartItem check results indexed by the ID of SKU.
Public property	ItemsCheckFailed	Indicates whether check has failed (at least one cart item check has failed).
Public property	ShippingOptionNotAvailable	Indicates that shipping option is not available for shopping cart.