OrderTemplate Class (BCL)
Encapsulates an order template in the Commerce order system. To create an OrderTemplate instance use the OrderContext.CreateOrderTemplate method.
System.Object
Microsoft.CommerceServer.Runtime.Orders.OrderGroup
Microsoft.CommerceServer.Runtime.Orders.OrderTemplate
Public Instance Methods
| Method | Description |
|---|---|
| Clear | Clears all the order forms and the addresses associated with the OrderTemplate object. |
| Delete | Purges the OrderTemplate object from the underlying stores. |
| Dispose (Inherited from OrderGroup) | Releases resources used by this object. |
| GetEnumerator (Inherited from OrderGroup) | Retrieves an enumerator on this collection. |
| 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 state of the OrderTemplate object with the specified template name to the underlying stores. |
| Save(String) | Persists the state of the OrderTemplate object with the specified template name to the underlying stores. |
Public Instance Properties
| Property | Description |
|---|---|
| Addresses (Inherited from OrderGroup) | Retrieves the collection of addresses associated with the OrderTemplate object. |
| HandlingTotal (Inherited from OrderGroup) | Retrieves the value of the saved_cy_handling_total key on the OrderGroup object. |
| 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 OrderTemplate object. |
| Name (Inherited from OrderGroup) | Accesses the order group name. |
| OrderForms (Inherited from OrderGroup) | Retrieves the order forms collection associated with this order group object. |
| OrderGroupID (Inherited from OrderGroup) | Accesses the order_group_id key on the OrderGroup.Value dictionary. |
| ShippingTotal (Inherited from OrderGroup) | Retrieves the value of the saved_cy_shipping_total key on the OrderTemplate object. |
| StatusCode | Accesses the order group status code on the OrderTemplate object. |
| SubTotal (Inherited from OrderGroup) | Retrieves the value of the saved_cy_oadjust_subtotal key on the OrderTemplate object. |
| TaxIncluded (Inherited from OrderGroup) | Retrieves the value of the saved_cy_tax_included key on the OrderTemplate object. |
| TaxTotal (Inherited from OrderGroup) | Retrieves the value of the saved_cy_tax_total key on the OrderTemplate object. |
| TemplateId | Retrieves the template ID of the OrderTemplate object. |
| Total (Inherited from OrderGroup) | Retrieves the value of the saved_cy_total_total key on the OrderTemplate object. |
| UserId | Retrieves the ID of the user associated with the OrderTemplate object. |
| Xml (Inherited from OrderGroup) | Accesses the XML format of the OrderTemplate object. |
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 managed resources. |
Remarks
An OrderTemplate object can be used to represent wish lists, recurring orders, shopping lists, or any other form of saved shopping basket. Multiple templates can exist for each user.
Requirements
Namespace: Microsoft.CommerceServer.Runtime.Orders
Platforms: Windows 2000, Windows Server 2003
Assembly: Microsoft.CommerceServer.Runtime.dll
Copyright © 2005 Microsoft Corporation.
All rights reserved.