OrderForm Class (PIA)

The OrderForm object provides for in-memory storage of user and purchase information. Microsoft Commerce Server 2002 sites use the OrderForm object to store the items that a user has chosen to purchase, and to store receipt information that reflects the purchase history for a given user.

Methods

Method Description
AddItem Adds the specified item to the items collection of the object.
ClearItems Clears the items collection of the object.
ClearOrderForm Clears the entire OrderForm object.

Remarks

The OrderForm object is defined internally as a structured group of SimpleList and Dictionary objects, and includes the methods required to add items, clear items, and clear the entire OrderForm object itself.

The base of the OrderForm object is a Dictionary object, which contains information that describes the entire order. This includes user information, such as the shopper ID, name, and address; and also order cost information, such as purchase subtotal, tax, shipping, and total.

The OrderForm object does not directly support storage of its data on disk. The DBStorage and OrderGroupManager objects enable persistent storage of OrderForm object data.

A number of the elements in the base Dictionary object of the OrderForm object include underscore (_) characters. The appearance of an underscore character in an element name indicates that these elements are not saved to the order form storage for the site. These elements are saved instead to the receipt storage of the site when the purchase is finalized.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Orders

Platforms: Windows 2000, Windows Server 2003

Assembly: MSCSCoreLib (in MSCSCoreLib.dll)

See Also

Business Process Objects

OrderGroup Class

OrderGroupManager Class

SimpleFindSearchInfo Class

SimpleFindResultInfo Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.