Basket Class (BCL)
Encapsulates a basket in the Commerce Server order system. The user ID must be specified to create an instance of this class.
**System.Object
** Microsoft.CommerceServer.Runtime.Orders.OrderGroup
Microsoft.CommerceServer.Runtime.Orders.Basket
Public Instance Methods
| Method | Description | |
|---|---|---|
| Add(OrderTemplate) | Adds the items from the specified order template to the basket instance. | |
| Add(PurchaseOrder) | Adds the items from the specified purchase order to the basket instance. | |
| Clear | Clears all the order forms and the addresses associated with the basket instance. | |
| Delete | Purges the basket instance from the underlying stores. | |
| Dispose (Inherited from OrderGroup) | Releases resources used by this object. | |
| GetEnumerator (Inherited from OrderGroup) | Retrieves the enumerator on this OrderGroup instance. | |
| RunPipeline(PipelineInfo) (Inherited from OrderGroup) | Runs the stages of the specified pipeline. | |
| RunPipeline(PipelineInfo, PipelineBase) (Inherited from OrderGroup) | Runs the stages of the specified pipeline. | |
| Save | Persists the basket instance to the underlying stores. | |
| SaveAsOrder | Persists the basket instance as a purchase order to the underlying stores. | |
| SetBillingAddress(String) | Sets the billing address property on every order form in the basket. | |
| SetPropertyOnOrderForms(String, Object) | Sets the specified property on every order form in the basket. | |
| SetShippingAddress(String) | Sets the shipping address property on every line item of every order form in the basket. | |
Public Instance Properties
| Property | Description |
|---|---|
| Addresses (Inherited from OrderGroup) | Retrieves the addresses collection associated with the OrderGroup instance. |
| BasketID | Accesses the BasketID field. |
| HandlingTotal (Inherited from OrderGroup) | Retrieves OrderForm.HandlingTotal properties in the OrderGroup instance. |
| Item(String) (Inherited from OrderGroup) | Retrieves and sets the value of a top-level property on the OrderGroup object. |
| LineItemCount (Inherited from OrderGroup) | Retrieves the count of all the line items on all the forms in the OrderGroup instance. |
| Name (Inherited from OrderGroup) | Accesses the order group name. |
| OrderForms (Inherited from OrderGroup) | Retrieves the OrderFormCollection associated with this OrderGroup object. |
| OrderGroupID (Inherited from OrderGroup) | Retrieves the ID associated with the OrderGroup instance. |
| ShippingTotal (Inherited from OrderGroup) | Retrieves the value of the ShippingTotal property for the OrderForm objects in the OrderGroup instance. |
| StatusCode | Accesses the order group status code on this basket instance. |
| SubTotal (Inherited from OrderGroup) | Retrieves the subtotal for the order group instance from the OrderForm.Subtotal property in this OrderGroup instance. |
| TaxIncluded (Inherited from OrderGroup) | Retrieves the order group instance total, including tax from the OrderForm.TaxIncluded properties in this OrderGroup instance. |
| TaxTotal (Inherited from OrderGroup) | Retrieves the total amount of tax from the OrderForm.TaxTotal property in this OrderGroup instance. |
| Total (Inherited from OrderGroup) | Retrieves the total amount for the OrderGroup instance. This amount includes shipping, handling and tax. |
| Xml (Inherited from OrderGroup) | Accesses the XML format of the order group instance. |
Protected Instance Methods
| Method | Description |
|---|---|
| CheckState (Inherited from OrderGroup) | Verifies that the object has not already been disposed. |
| Dispose(Boolean) | Releases the unmanaged resources used by this class and optionally releases the managed resources. |
Requirements
Namespace: Microsoft.CommerceServer.Runtime.Orders
Platforms: Windows 2000, Windows Server 2003
Assembly: Microsoft.CommerceServer.Runtime.dll
See Also
Example Code for the Microsoft.CommerceServer.Runtime.Orders Namespace
Copyright © 2005 Microsoft Corporation.
All rights reserved.