ShoppingCartItemCheckResult Class

Note: This API is now obsolete.

Class encapsulating the results of cart item check.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.ShoppingCartItemCheckResult

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

Syntax

[ObsoleteAttribute("Use ShoppingCartItemValidator instead.")]
public class ShoppingCartItemCheckResult

The ShoppingCartItemCheckResult type exposes the following members.

Constructors

	Name	Description
Public method	ShoppingCartItemCheckResult

Properties

	Name	Description
Public property	CartItem	Affected shopping cart item object.
Public property	CheckFailed	Indicates whether the check has failed.
Public property	HasOtherErrors	Indicates whether result has any other (custom) errors.
Public property	InventoryUnits	Number of available units when not enough. Value is set to -1 when all requested units are available.
Public property	MaxUnits	Maximum unit count in one order. Value is set to -1 when maximum units in order condition is met.
Public property	MaxUnitsExceeded	Indicates that maximum unit count in one order condition is not met.
Public property	MinUnits	Minimum unit count in one order. Value is set to -1 when minimum units in order condition is met.
Public property	MinUnitsNotReached	Indicates that minimum unit count in one order condition is not met.
Public property	NotEnoughUnits	Indicates that requested unit count is not available.
Public property	OtherErrors	List of other (custom) error messages.
Public property	ProductDisabled	Indicates that product is disabled.
Public property	ProductValidityExpired	Indicates that product has expired.
Public property	RegisteredCustomerRequired	Indicates that product can not be purchased, because it requires registered customer.

Methods

	Name	Description
Public method	CombineWithResult	Includes specified check result into this object in order to find the most restrictive values. No action is taken when results belong to different SKUs.
Public method	GetFormattedMessage	Returns formatted result message when check has failed. Message is HTML-formatted: each error on its own line. Returns empty string if check passed.
Protected method	GetMax	Returns larger value from params. Values below 0 are considered to be "not specified".
Public method	GetMessage	Returns check result formatted as string. Message contains individual error messages separated with specified separator. Empty string is returned when no errors found.
Protected method	GetMin	Returns smaller value from params. Values below 0 are considered to be "not specified".
Public method	MarkMaxUnitsFailed	Marks this result as "Maximum unit count not reached".
Public method	MarkMinUnitsFailed	Marks this result as "Minimum unit count not reached".
Public method	MarkNotEnoughUnits	Marks this result as "Not enough units available".
Public method	MarkOtherError	Marks this result with error message. Use this method to report custom errors. Duplicate entries are removed.