Catalog Objects

This topic provides a brief description of the key classes and enumerations in the Microsoft.CommerceServer.Catalog namespace and the Microsoft.CommerceServer.Inventory namespace.

Classes

The following table describes the key public classes in the Microsoft.CommerceServer.Catalog namespace.

Class

Description

BaseCatalog

A type of product catalog with concretely defined data and that does not aggregate data from other catalogs. A base catalog is a source catalog from which a virtual catalog is derived.

CatalogContext

Contains the functionality to manage the catalog and inventory systems. A CatalogContext object is the root object for the Catalog System.

CatalogDefinition

Provides properties and methods to manage catalog and category definitions.

CatalogExportOptions

Specifies the set of options to use for a catalog export operation.

CatalogImportOptions

Specifies the set of options to use for a catalog import operation.

CatalogItem

An abstract class that represents an item in the catalog database. Product and category objects derive from this class.

CatalogObjectBase

An abstract class that contains the properties and methods of the catalog system. The CatalogObjectBase is the base type for all catalog objects.

CatalogProperty

An abstract class that provides properties and methods to manage catalog properties.

CatalogRule

An abstract class that implements functionality of the catalog rules. PricingRule and VirtualCatalogRule derive from this class.

CatalogSearch

Used to search catalogs. This object provides free-text and SQL WHERE clause searches.

CatalogSearchOptions

Provides properties to customize the catalog search results when performing searches on one or more catalogs.

CatalogServiceAgent

Contains configuration information to communicate with a Web service using XML and SOAP.

CatalogSiteAgent

Contains configuration for a connection directly to a Commerce Server Core Systems site's catalog database.

Category

An abstract class that manages a category in a catalog. StaticCategory derives from this class.

CategoryConfiguration

Specifies the configuration of a category, including its child categories and products.

ExportOptions

Specifies a set of options to use for a catalog export operation.

ImportOptions

Specifies the set of options to use for a catalog import operation.

MultilingualCatalogObject

An abstract class that provides access to a product catalog, either base or virtual.

PricingRule

Manages the pricing rules that are applied to a catalog.

Product

An abstract class that represents a product in a catalog.

ProductCatalog

An abstract class that provides access to the details of a product catalog (base or virtual), catalog search, and product and category management.

ProductFamily

Manages a product family in a catalog.

SearchOptions

Provides the properties to customize search results.

SpecificationSearch

Provides a specification or guided search of a catalog.

StaticCategory

Manages a static category, which is a category to which product catalogs are explicitly added and removed.

Variant

Represents a single product variant in a product family.

VirtualCatalog

A type of product catalog that contains data built from other catalogs.

VirtualCatalogRule

Manages the inclusion and exclusion rules for a virtual catalog.

XmlImportOptions

Specifies the set of options used during an XML import operation.

The following table describes the key public classes in the Microsoft.CommerceServer.Inventory namespace.

Class

Description

InventoryCatalog

Manages an inventory catalog.

InventoryContext

Contains the functionality to manage the Inventory System. The InventoryContext object is the root object for the Inventory System.

InventoryExportOptions

Specifies the set of options to use for an inventory catalog export operation.

InventoryImportOptions

Specifies the set of options to use for an inventory catalog import operation.

InventoryOptions

Specifies inventory options used for searches.

InventoryQuantityDelta

Manages the inventory delta information.

InventorySku

Manages the properties of an inventory SKU.

Enumerations

The following table describes the enumerations in the Microsoft.CommerceServer.Catalog namespace.

Enumeration

Description

AuthorizationScope

Specifies the scope of a catalog authorization policy.

CatalogClassTypes

Specifies the type of catalog object to return from a search. This enumeration represents the different class types that the catalog controls can validate.

CatalogDataType

Specifies the valid data types for catalog properties.

CatalogDefinitionType

Specifies the definition type (product or category).

CatalogFlags

Flag that specifies whether a virtual catalog is materialized.

DefinitionPropertyType

Specifies the definition property type.

ExportMode

Specifies the type of export operation.

ExtensibleEntityType

Specifies the class of entities that can be extended by adding user-defined properties.

ImportMode

Specifies the type of catalog import operation.

ImportOperation

Specifies the catalog import validation mode.

OperationType

Specifies the type of import or export operation.

SchemaExportType

Specifies the schema export mode during a catalog export operation.

StockStatus

Specifies the status of an inventory SKU.

TransactionMode

Specifies the catalog import transaction mode.

VirtualCatalogRuleType

Specifies whether to include catalog, product, category, or variant in a virtual catalog.

VirtualCatalogStatus

Specifies the virtual catalog status.

The following table describes the public enumerations in the Microsoft.CommerceServer.Inventory namespace.

Enumeration

Description

InventoryCondition

Enumerates the condition of the SKU.

See Also

Other Resources

Core Catalog System Object Model