Microsoft.CommerceServer.Orders Namespace

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

The Order acts as a container for all information associated with a particular user’s order.

The Orders System offers a Microsoft .NET managed code API with a strongly typed object model that you can use to customize a Commerce Server Web site to meet your specific business needs.

The Orders System provides developers with the following benefits:

• Abstraction of the SQL database. Developers do not have to work directly with stored procedures or SQL tables.

• Extensibility. The Orders System offers developers managed object model integration that allows for quick development of extensions to the system.

• Independent Software Vendor (ISV) plug-in for the order-processing pipeline. This feature lets developers quickly plug in custom pipelines.

• Transaction support. The Orders System performs transactions for all read and write operations for purchase order objects to maintain data consistency across tables in the Orders System SQL database.

• Mapped storage. The Orders System maps purchase order objects to SQL tables so developers can easily mine purchase order data in the database.

• Web services. The Orders System uses a service-oriented architecture that can send orders to a line-of-business system.

• Out-of-the-box Customer and Orders Manager user interface. The Commerce Server Customer and Orders Manager provides a detailed user interface for orders management. Developers do not need to create new interfaces for the Orders System.

Classes

	Class	Description
	BasketManager	Manages storage and retrieval of Basket objects. This class cannot be inherited.
	DefaultLanguageNotDeletedException	The exception that is thrown when an attempt is made to delete payment method or shipping method language sensitive properties for a language that is designated the default language.
	LanguageNotFoundException	The exception that is thrown when payment method or shipping method properties are requested in a language that does not exist.
	MalformedDataSetException	The exception that is thrown when the data set supplied does not conform to the required database schema. It could be because of an incorrect number of data tables, name of a data table, number of columns, column name or column data type.
	OrderGroupConversionException	The exception that is thrown during conversion of a basket to a purchase order when a strongly-typed or weakly-typed property of the basket has the same name but a different type as a strongly-named property of the PurchaseOrder class.
	OrderManagementContext	Serves as the starting point for all management operations in the orders data management system. This class cannot be inherited.
	OrderNotSavedException	The exception that is thrown when a purchase order is not saved to the database.
	OrderSearchClauseFactory	Initializes a new instance of the OrderSearchClauseFactory class.
	OrderServiceAgent	Class which creates the webservice proxy for the agent.
	OrderServices	An abstract class. Manages orders for the online shopping site.
	OrderSiteAgent	Class which should be used to create OrderManagementContext instance in the non-web environment.
	PaymentMethod	Controls and manages the payment methods, such as a credit card. This class cannot be inherited.
	PaymentMethodCollection	Manages a collection of payment methods.
	PaymentMethodDataSet	The strongly typed DataSet that is used to access the payment methods in the Orders system.
	PaymentMethodDataSet..::.PaymentMethodDataTable	Class which depicts the PaymentMethods DataTable in the PaymentMethodDataSet.
	PaymentMethodDataSet..::.PaymentMethodRow	The strongly typed DataRow that provides access to the rows of a PaymentMethodDataSet.
	PaymentMethodDataSet..::.PaymentMethodRowChangeEvent	Event generated when a row in the PaymentMethodDataSet..::.PaymentMethodDataTable changes.
	PaymentMethodManager	Manages storage and retrieval of PaymentMethod objects. This class cannot be inherited.
	PaymentMethodNotFoundException	The exception that is thrown when a user tries to load a PaymentMethod which does not have a default language specified.
	PaymentMethodNotSavedException	The exception that is thrown when an optimistic concurrency failure occurs while saving the payment methods.
	PaymentMethodRouterPipelineComponent	A pipeline component for the Payment Method.
	PipelineExecutionException	The exception that is thrown when an error occurs during pipeline execution.
	PurchaseOrderManager	Manages storage and retrieval of PurchaseOrder objects. This class cannot be inherited.
	RecordNotFoundException	The exception that is thrown when a Basket or PurchaseOrder with the specified identifier cannot be found.
	RegionCodeDataSet	The strongly typed DataSet that is used to access the RegionCode methods in the Orders system.
	RegionCodeDataSet..::.CountryCodesDataTable	Class which depicts the CountryCodes DataTable in the RegionCodeDataSet.
	RegionCodeDataSet..::.CountryCodesDataTable..::.CodeChangeEventArg	Provides data for the CodeChanged and CodeChanging events.
	RegionCodeDataSet..::.CountryCodesDataTable..::.CreatedChangeEventArg	Provides data for the CreatedChanged and the CreatedChanging events.
	RegionCodeDataSet..::.CountryCodesDataTable..::.DescriptionChangeEventArg	Provides data for the DescriptionChanged and DescriptionChanging events.
	RegionCodeDataSet..::.CountryCodesDataTable..::.LastModifiedChangeEventArg	Provides data for the LastModifiedChanged and LastModifiedChanging events.
	RegionCodeDataSet..::.CountryCodesDataTable..::.ModifiedByChangeEventArg	Provides data for the ModifiedByChanged and ModifiedByChanging events.
	RegionCodeDataSet..::.CountryCodesDataTable..::.NameChangeEventArg	Provides data for the NameChanged and NameChanging events.
	RegionCodeDataSet..::.CountryCodesRow	Contains the methods and properties to get the values within a specific row of the RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesRowChangeEvent	Provides data for the change events of the RegionCodeDataSet..::.CountryCodesDataTable class.
	RegionCodeDataSet..::.StateCodesDataTable	Class which depicts the StateCodes Data table in the RegionCodeDataSet.
	RegionCodeDataSet..::.StateCodesDataTable..::.CodeChangeEventArg	Provides data for the CodeChanged and CodeChanging events.
	RegionCodeDataSet..::.StateCodesDataTable..::.CountryCodeChangeEventArg	Provides data for the CountryCodeChanged and CountryCodeChanging events.
	RegionCodeDataSet..::.StateCodesDataTable..::.CreatedChangeEventArg	Provides data for the CreatedChanged and the CreatedChanging events.
	RegionCodeDataSet..::.StateCodesDataTable..::.DescriptionChangeEventArg	Provides data for the DescriptionChanged and DescriptionChanging events.
	RegionCodeDataSet..::.StateCodesDataTable..::.LastModifiedChangeEventArg	Provides data for the LastModifiedChanged and LastModifiedChanging events.
	RegionCodeDataSet..::.StateCodesDataTable..::.ModifiedByChangeEventArg	Provides data for the ModifiedByChanged and ModifiedByChanging events.
	RegionCodeDataSet..::.StateCodesDataTable..::.NameChangeEventArg	Provides data for the NameChanged and NameChanging events.
	RegionCodeDataSet..::.StateCodesRow	Contains the methods and properties to get the values within a specific row of the RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesRowChangeEvent	Provides data for the change events of the RegionCodeDataSet..::.StateCodesDataTable class.
	ShippingMethod	Manages shipping methods for a Microsoft Commerce Server site.
	ShippingMethodCollection	Manages the collection of shipping methods.
	ShippingMethodDataSet	The strongly typed DataSet that is used to access the shipping methods in the Orders system.
	ShippingMethodDataSet..::.ShippingMethodDataTable	Class which depicts the ShippingMethods DataTable in the ShippingMethodDataSet.
	ShippingMethodDataSet..::.ShippingMethodRow	Contains the methods and properties to get the values within a specific row of the ShippingMethodDataSet..::.ShippingMethodDataTable.
	ShippingMethodDataSet..::.ShippingMethodRowChangeEvent	Provides data for the change events of the ShippingMethodDataSet ShippingMethodDataSet..::.ShippingMethodDataTable class.
	ShippingMethodManager	Manages storage and retrieval of ShippingMethod objects. This class cannot be inherited.
	ShippingMethodNotFoundException	The exception that is thrown when a user tries to load a ShippingMethod which does not have a default language specified.
	ShippingMethodNotSavedException	The exception that is thrown when an optimistic concurrency failure occurs while saving the shipping methods.
	ShippingRatesDataSet	The strongly typed DataSet that is used to access the shipping rates in the Orders system.
	ShippingRatesDataSet..::.ShippingRatesDataTable	Class which depicts the ShippingRates DataTable in the ShippingRatesDataSet.
	ShippingRatesDataSet..::.ShippingRatesDataTable..::.MaxLimitChangeEventArg	Provides data for the MaxLimitChanged and MaxLimitChanging events.
	ShippingRatesDataSet..::.ShippingRatesDataTable..::.PriceChangeEventArg	Provides data for the PriceChanged and PriceChanging events.
	ShippingRatesDataSet..::.ShippingRatesRow	Contains the methods and properties to get the values within a specific row of the ShippingRatesDataSet..::.ShippingRatesDataTable.
	ShippingRatesDataSet..::.ShippingRatesRowChangeEvent	Provides data for the change events of the ShippingRatesDataSet..::.ShippingRatesDataTable class.
	UnsupportedTypeException	The exception that is thrown when the object being serialized contains a property which cannot be serialized.

Delegates

	Delegate	Description
	PaymentMethodDataSet..::.PaymentMethodRowChangeEventHandler	Represents the method that will handle the PaymentMethodDataSet..::.PaymentMethodRowChangeEvent events of a PaymentMethodDataSet.
	RegionCodeDataSet..::.CountryCodesDataTable..::.CodeChangeEventHandler	Represents the method that will handle the CodeChanged and CodeChanging events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesDataTable..::.CreatedChangeEventHandler	Represents the method that will handle the CreatedChanged and CreatedChanging events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesDataTable..::.DescriptionChangeEventHandler	Represents the method that will handle the DescriptionChanged and DescriptionChanging events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesDataTable..::.LastModifiedChangeEventHandler	Represents the method that will handle the LastModifiedChanged and LastModifiedChanging events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesDataTable..::.ModifiedByChangeEventHandler	Represents the method that will handle the ModifiedByChanged and ModifiedByChanging events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesDataTable..::.NameChangeEventHandler	Represents the method that will handle the NameChanged and NameChanging events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.CountryCodesRowChangeEventHandler	Represents the method that will handle the RegionCodeDataSet..::.CountryCodesRowChangeEvent events of a RegionCodeDataSet..::.CountryCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.CodeChangeEventHandler	Represents the method that will handle the CodeChanged and CodeChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.CountryCodeChangeEventHandler	Represents the method that will handle the CountryCodeChanged and CountryCodeChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.CreatedChangeEventHandler	Represents the method that will handle the CreatedChanged and CreatedChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.DescriptionChangeEventHandler	Represents the method that will handle the DescriptionChanged and DescriptionChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.LastModifiedChangeEventHandler	Represents the method that will handle the LastModifiedChanged and LastModifiedChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.ModifiedByChangeEventHandler	Represents the method that will handle the ModifiedByChanged and ModifiedByChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesDataTable..::.NameChangeEventHandler	Represents the method that will handle the NameChanged and NameChanging events of a RegionCodeDataSet..::.StateCodesDataTable.
	RegionCodeDataSet..::.StateCodesRowChangeEventHandler	Represents the method that will handle the RegionCodeDataSet..::.StateCodesRowChangeEvent events of a RegionCodeDataSet..::.StateCodesDataTable.
	ShippingMethodDataSet..::.ShippingMethodRowChangeEventHandler	Represents the method that will handle the ShippingMethodDataSet..::.ShippingMethodRowChangeEvent events of a ShippingMethodDataSet.
	ShippingRatesDataSet..::.ShippingRatesDataTable..::.MaxLimitChangeEventHandler	Represents the method that will handle the ShippingRatesDataSet..::.ShippingRatesDataTable..::.MaxLimitChangeEventArg events of a ShippingRatesDataSet..::.ShippingRatesDataTable.
	ShippingRatesDataSet..::.ShippingRatesDataTable..::.PriceChangeEventHandler	Represents the method that will handle the ShippingRatesDataSet..::.ShippingRatesDataTable..::.PriceChangeEventArg events of a ShippingRatesDataSet..::.ShippingRatesDataTable.
	ShippingRatesDataSet..::.ShippingRatesRowChangeEventHandler	Represents the method that will handle the ShippingRatesDataSet..::.ShippingRatesRowChangeEvent events of a ShippingRatesDataSet..::.ShippingRatesDataTable.

Enumerations

	Enumeration	Description
	DiscountType	Specifies the meaning of numeric data in a DiscountApplicationRecordBase object.
	PaymentMethodTypes	Specifies the type of payment.
	PromoCodeState	Specifies the results of the PromoCode execution that occurred during processing in the PromoCode Pipeline component.
	StatusCodes	Describes the type of order group.