OrderGroup Class (BCL)

Article
11/12/2009

The OrderGroup class is the abstract base class for all OrderGroup types in the Commerce Server order system.

The OrderGroup class represents a purchasing unit, such as a basket, purchase order, order template, or any other user-defined type. The only way to programmatically differentiate these is by using the order_status_code top-level OrderGroup property. The Commerce Server.NET-based order system refines this approach by exposing the three fundamental OrderGroup object types, Basket, PurchaseOrder and OrderTemplate, as first-class entities derived from the OrderGroup abstract class.

System.Object
   Microsoft.CommerceServer.Runtime.Orders.OrderGroup
      Microsoft.CommerceServer.Runtime.Orders.Basket
      Microsoft.CommerceServer.Runtime.Orders.OrderTemplate
      Microsoft.CommerceServer.Runtime.Orders.PurchaseOrder

Protected Instance Constructor

Constructor	Description
OrderGroup Constructor	Creates a new instance of the OrderGroup class.

Public Instance Methods

Method	Description
Dispose	Releases resources used by this object.
GetEnumerator	Retrieves the enumerator on this OrderGroup instance.
RunPipeline(PipelineInfo)	Runs the stages of the specified pipeline.
RunPipeline(PipelineInfo, PipelineBase)	Runs the stages of the specified pipeline.

Public Instance Properties

Property	Description
Addresses	Retrieves the collection of addresses associated with the OrderGroup instance.
HandlingTotal	Retrieves OrderForm.HandlingTotal properties in the OrderGroup instance.
Item(String)	Retrieves and sets the value of a top-level property on the OrderGroup object.
LineItemCount	Retrieves the count of all the line items on all the forms in the OrderGroup instance.
Name	Accesses the order group name.
OrderForms	Retrieves the OrderFormCollection associated with this OrderGroup object.
OrderGroupID	Retrieves the ID associated with the OrderGroup instance.
ShippingTotal	Retrieves the value of the ShippingTotal properties for the OrderForm objects in the OrderGroup instance.
StatusCode	Accesses the order group status code on this OrderGroup instance.
SubTotal	Retrieves the subtotal for the order group instance from the OrderForm.Subtotal properties in this OrderGroup instance.
TaxIncluded	Retrieves the order group instance total, including tax from the OrderForm.TaxIncluded properties in this OrderGroup instance.
TaxTotal	Retrieves the total amount of tax from the OrderForm.TaxTotal properties in this OrderGroup instance.
Total	Retrieves the total amount for the OrderGroup instance. This amount includes shipping, handling and tax.
Xml	Accesses the XML persistence format of the OrderGroup instance.

Protected Instance Methods

Method	Description
CheckState	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