ShippingMethodManager Object [C++]
Use this object to manage shipping methods that will be available on the site. Using the ShippingMethodManager object, you can add and remove methods, set their description, availability, and configuration.
| ProgID: | Commerce.ShippingMethodManager (Externally creatable) |
| COM Class Name: | ShippingMethodManager |
| Type Library Name: | Microsoft Commerce 2002 Shipping Components Type Library |
| DLL Name: | shipmgr.dll |
| Threading Model: | Apartment |
[C++]
| COM Interface Name: | _ShippingMethodManager |
| Interface ID Constant: | None |
| Header File: | None |
[C++]
Because this object is primarily intended for use within ASP script, access from C++ will not be common.
Methods
[C++]
| Method | Description |
|---|---|
| CreateMethodInstance | Creates an empty instance of a shipping method. |
| DeleteMethodInstance | Deletes the current shipping method instance. |
| GetComponentConfig | Retrieves the Configuration dictionary for the shipping component, which implements the current shipping method. |
| GetInstalledMethodList | Returns a recordset containing the current shipping methods. |
| GetMethodInfo | Returns a recordset containing information about one or more shipping methods. |
| Initialize | Initializes the ShippingMethodManager object and connects it to a database. |
| LoadMethodInstance | Loads a given shipping method to be manipulated by other methods. |
| SaveMethodConfig | Saves configuration information about the current method. |
| SetCachableComponentConfig | Saves configuration and other component information for a component. |
| SetMethodConfig | Sets name/value pairs for the current method. |
[Visual Basic]
| Method | Description |
|---|---|
| CreateMethodInstance | Creates an empty instance of a shipping method. |
| DeleteMethodInstance | Deletes the current shipping method instance. |
| GetComponentConfig | Retrieves the Configuration dictionary for the shipping component, which implements the current shipping method. |
| GetInstalledMethodList | Returns a recordset containing the current shipping methods. |
| GetMethodInfo | Returns a recordset containing information about the loaded shipping method. |
| Initialize | Initializes the ShippingMethodManager object and connects it to a database. |
| LoadMethodInstance | Loads a given shipping method to be manipulated by other methods. |
| SaveMethodConfig | Saves configuration information about the current method. |
| SetCachableComponentConfig | Saves configuration and other component information for a component. |
| SetMethodConfig | Sets name/value pairs for the current method. |
Remarks
The shipping architecture in Commerce Server 2002 is designed so that shipping methods can be changed through the Shipping Methods module in Commerce Server Business Desk without programming or editing pipelines. To do this, Commerce Server maintains a database table, ShippingConfig, of shipping methods and the information required to configure shipping components to implement those methods.
The ShippingMethodManager object is used by Business Desk to manage the ShippingConfig database table.
For more information about shipping objects, see Multiple-shipment Shipping Architecture.
Copyright © 2005 Microsoft Corporation.
All rights reserved.