CouponCodeCollection Class

Represents the collection of coupon codes.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.CouponCodeCollection

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

Syntax

[SerializableAttribute]
public sealed class CouponCodeCollection : ICouponCodeCollection, 
	IReadOnlyCouponCodeCollection, ICouponCodeApplication

The CouponCodeCollection type exposes the following members.

Constructors

	Name	Description
Public method	CouponCodeCollection

Properties

	Name	Description
Public property	AllAppliedCodes	Gets all applied coupon codes.
Public property	CartAppliedCodes	Gets coupon codes that are already applied in cart.
Public property	Codes	Gets the coupon codes.
Public property	CouponCodes	Gets the coupon codes.
Public property	NotAppliedInCartCodes	Gets coupon codes, that are in cart, but not applied.
Public property	OrderAppliedCodes	Gets all applied coupon codes that are already applied in order.

Methods

	Name	Description
Public method	Add	Adds coupon with given couponCode and status to the collection.
Public method	Apply	Applies all applicable coupon codes during order creation.
Public method Static member	Deserialize	Returns a new instance of CouponCodeCollection deserialized from given string.
Public method	IsAppliedInCart	Returns true when given codes is present and was applied in cart.
Public method	IsAppliedInOrder	Returns true when given codes is present and was applied in order.
Public method	IsNotAppliedInCart	Returns true when given codes is present in cart, but it is not applied.
Public method	Merge	Merge existing coupon codes with given ones.
Public method	Remove	Removes the coupon with given couponCode from collection. Does nothing when no such coupon exists.
Public method	Serialize	Serializes the collection into string.