Microsoft.CommerceServer.Catalog Namespace

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

Microsoft Commerce Server Catalog System allows users on the site to browse and search for products. The Management system allows business managers to create and manage products and categories in catalogs.

The Commerce Server 2007 Catalog Manager provides catalog managers and editors with the tools needed to manipulate existing product catalogs.

The classes in the Microsoft.CommerceServer.Catalog namespace contains the caching functionality for the Commerce Server Class Library.

Classes

	Class	Description
	BaseCatalog	A type of product catalog whose data is concretely defined and does not aggregate data from other catalogs. This class cannot be inherited.
	BuiltInEntityException	The exception that is thrown when attempting to modify or delete a built-in object.
	BuiltInReadOnlyPropertyUpdateException	The exception that is thrown when attempting to modify a built-in, read-only object.
	CacheConfiguration	This class contains the members to configure the timeouts for the various elements in the cache.
	CatalogAuthorizationException	The exception that is thrown when catalog system authorization fails.
	CatalogContext	The CatalogContext class contains the functionality to manage the catalog and inventory systems. This class cannot be inherited.
	CatalogDatabaseException	The exception that is thrown when an unexpected database failure is encountered by the catalog server.
	CatalogDefinition	Provides properties and methods to manage catalog and category definitions.
	CatalogDefinitionPropertiesDataSet	Access the CatalogDefinitionProperties values in the CatalogDefinitionPropertiesDataSet.
	CatalogDefinitionPropertiesDataSet..::.CatalogDefinitionPropertiesDataTable	The data table that contains the CatalogDefinitionProperties.
	CatalogDefinitionPropertiesDataSet..::.CatalogDefinitionProperty	Allows access to the CatalogDefinitionPropertiesDataSet..::.CatalogDefinitionPropertiesDataTable table.
	CatalogDefinitionPropertiesDataSet..::.CatalogDefinitionPropertyChangeEvent	Allows access to the change events of the CatalogDefinitionPropertiesDataSet table. Provides data for the CatalogDefinitionPropertiesDataSet events.
	CatalogDefinitionPropertiesDataSetSchema	Schema description for CatalogDefinitionPropertiesDataSet.
	CatalogDefinitionsDataSet	The strongly typed DataSet that is used to access the Catalog Definitions in the Catalog system.
	CatalogDefinitionsDataSet..::.CatalogDefinition	Allows access to the CatalogDefinitionsDataSet..::.CatalogDefinitionsDataTable table.
	CatalogDefinitionsDataSet..::.CatalogDefinitionChangeEvent	Allows access to the change events of the CatalogDefinitionsDataSet..::.CatalogDefinitionsDataTable table. Provides data for the CatalogDefinitionsDataSet events.
	CatalogDefinitionsDataSet..::.CatalogDefinitionsDataTable	The data table that contains the CatalogDefinitions.
	CatalogDefinitionsDataSetSchema	Schema description for CatalogDefinitionsDataSet.
	CatalogDeleteException	The exception that is thrown when an attempt to delete an object fails.
	CatalogEnumerationProperty	Adds values for the enumeration property.
	CatalogEnumerationPropertyValuesDataSet	The strongly typed DataSet that is used to access the Catalog enumerations in the Catalog system.
	CatalogEnumerationPropertyValuesDataSet..::.EnumerationPropertyValue	Allows access to CatalogEnumerationPropertyValuesDataSet..::.EnumerationPropertyValuesDataTable table.
	CatalogEnumerationPropertyValuesDataSet..::.EnumerationPropertyValueChangeEvent	Allows access to the change events of the CatalogEnumerationPropertyValuesDataSet..::.EnumerationPropertyValuesDataTable table. Provides data for the CatalogEnumerationPropertyValuesDataSet events.
	CatalogEnumerationPropertyValuesDataSet..::.EnumerationPropertyValuesDataTable	The data table that contains the EnumerationPropertyValues.
	CatalogEnumerationPropertyValuesDataSetSchema	Schema description for CatalogEnumerationPropertyValuesDataSet.
	CatalogError	This class contains the error information for errors that occurred during the import, export and rebuild operations
	CatalogErrorCollection	A collection of catalog errors in the product catalog system. This class cannot be inherited.
	CatalogException	Acts as the base type for all catalog-specific exceptions raised by the product catalog system.
	CatalogExportException	The exception that is thrown when an export operation fails.
	CatalogExportOptions	Specifies the set of options to use for a catalog export operation.
	CatalogImportException	The exception that is thrown when an import operation fails.
	CatalogImportOptions	Specifies the set of options to use for a catalog import operation.
	CatalogInitializationException	The exception that is thrown when the catalog server is incorrectly configured and cannot be started.
	CatalogItem	Represents an item in the catalog database.
	CatalogItemConfiguration	Describes the pre-loaded configuration of a catalog object sub component.
	CatalogItemsDataSet	Access the CatalogItems values in the CatalogItemsDataSet.
	CatalogItemsDataSet..::.CatalogItem	Allows access to the CatalogItemsDataSet..::.CatalogItemsDataTable table.
	CatalogItemsDataSet..::.CatalogItemChangeEvent	Allows access to the change events of the CatalogItemsDataSet..::.CatalogItemsDataTable table. Provides data for the CatalogItemsDataSet events.
	CatalogItemsDataSet..::.CatalogItemsDataTable	The data table that contains the Catalog Items.
	CatalogItemsDataSetSchema	Schema description for CatalogItemsDataSet.
	CatalogObject	An abstract class that contains properties and methods of the catalog system.
	CatalogObjectBase	An abstract class that contains properties and methods of the catalog system. The CatalogObjectBase is the base type for all catalog objects.
	CatalogObjectCollection<(Of <(TObject, TDataSet>)>)	An abstract class; CatalogObject collection is the base type for all collections of catalog objects.
	CatalogOperationsProgress	Provides information regarding the progress of the import, export and rebuild operations.
	CatalogPricingException	Base Exception for all pricing related exceptions.
	CatalogPricingRulesDataSet	Access the CatalogPricingRulesDataSet..::.PricingRule values in the CatalogPricingRulesDataSet.
	CatalogPricingRulesDataSet..::.PricingRule	Allows access to the CatalogPricingRulesDataSet..::.PricingRulesDataTable table.
	CatalogPricingRulesDataSet..::.PricingRuleChangeEvent	Allows access to the change events of the CatalogPricingRulesDataSet..::.PricingRulesDataTable table. Provides data for the CatalogPricingRulesDataSet events.
	CatalogPricingRulesDataSet..::.PricingRulesDataTable	The data table that contains the PricingRules.
	CatalogPricingRulesDataSetSchema	Schema description for CatalogPricingRulesDataSet.
	CatalogPropertiesDataSet	Access the CatalogProperties values in the CatalogPropertiesDataSet.
	CatalogPropertiesDataSet..::.CatalogPropertiesDataTable	The data table that contains the CatalogProperties.
	CatalogPropertiesDataSet..::.CatalogProperty	Allows access to the CatalogPropertiesDataSet..::.CatalogPropertiesDataTable table.
	CatalogPropertiesDataSet..::.CatalogPropertyChangeEvent	Allows access to the change events of the CatalogPropertiesDataSet..::.CatalogPropertiesDataTable table. Provides data for the CatalogPropertiesDataSet events.
	CatalogPropertiesDataSetSchema	Schema description for CatalogPropertiesDataSet.
	CatalogProperty	Provides properties and methods to manage catalog properties.
	CatalogPropertyCollection	Collection of catalog properties in the product catalog system. This class cannot be inherited.
	CatalogPup	Implements the methods in the IPup interface
	CatalogRebuildException	The exception that is thrown when a catalog cannot be rebuilt.
	CatalogRelationshipsDataSet	Access the CatalogRelationships values in the CatalogRelationshipsDataSet.
	CatalogRelationshipsDataSet..::.CatalogRelationship	Allows access to the CatalogRelationshipsDataSet..::.CatalogRelationshipsDataTable table.
	CatalogRelationshipsDataSet..::.CatalogRelationshipChangeEvent	Allows access to the change events of the CatalogRelationshipsDataSet..::.CatalogRelationshipsDataTable table. Provides data for the CatalogRelationshipsDataSet events.
	CatalogRelationshipsDataSet..::.CatalogRelationshipsDataTable	The data table that contains the CatalogRelationships.
	CatalogRelationshipsDataSetSchema	Schema description for CatalogRelationshipsDataSet.
	CatalogRemoveException	The exception that is thrown when an attempt to remove an association between two objects fails.
	CatalogRenameException	The exception that is thrown when an attempt to rename an object fails.
	CatalogRule	An abstract class. Implements functionality of the Catalog Rules.
	CatalogSaveException	The exception that is thrown when an attempt to save an object fails.
	CatalogSchemaVersionException	The exception that is thrown when a site's product catalog database is not the correct version for the installed server.
	CatalogsDataSet	Access the CatalogsDataSet..::.Catalog values in the CatalogsDataSet.
	CatalogsDataSet..::.Catalog	Allows access to the CatalogsDataSet..::.CatalogsDataTable table.
	CatalogsDataSet..::.CatalogChangeEvent	Allows access to the change events of the CatalogItemsDataSet..::.CatalogItemsDataTable table. Provides data for the CatalogsDataSet events.
	CatalogsDataSet..::.CatalogsDataTable	The data table that contains the Catalogs.
	CatalogsDataSetSchema	Schema description for CatalogsDataSet.
	CatalogSearch	Used to search catalogs. Use this class to perform searches against product, variant, and category data in one or more catalogs.
	CatalogSearchOptions	Provides properties to customize the catalog search results when performing searches on one or more catalogs.
	CatalogServiceAgent	Class for communicating with a specific Web service using the provided type of Web service proxy object.
	CatalogSetsDataSet	Access the CatalogSetsDataSet..::.CatalogSetsDataTable values in the CatalogSetsDataSet.
	CatalogSetsDataSet..::.CatalogSet	Allows access to the CatalogSetsDataSet..::.CatalogSetsDataTable table.
	CatalogSetsDataSet..::.CatalogSetChangeEvent	Allows access to the change events of the CatalogSetsDataSet..::.CatalogSetsDataTable table. Provides data for the CatalogSetsDataSet events.
	CatalogSetsDataSet..::.CatalogSetsDataTable	The data table that contains the CatalogSets.
	CatalogSetsDataSetSchema	Schema description for CatalogSetsDataSet.
	CatalogSiteAgent	The CatalogSiteAgent class contains configuration for a connection directly to a Commerce Server site's catalog database. This class cannot be inherited.
	CatalogVirtualCatalogRulesDataSet	Access the VirtualCatalogRules values in the CatalogVirtualCatalogRulesDataSet.
	CatalogVirtualCatalogRulesDataSet..::.VirtualCatalogRule	Allows access to the CatalogVirtualCatalogRulesDataSet..::.VirtualCatalogRulesDataTable table.
	CatalogVirtualCatalogRulesDataSet..::.VirtualCatalogRuleChangeEvent	Allows access to the change events of the CatalogVirtualCatalogRulesDataSet table. Provides data for the CatalogDefinitionPropertiesDataSet events.
	CatalogVirtualCatalogRulesDataSet..::.VirtualCatalogRulesDataTable	The data table that contains the VirtualCatalogRules.
	CatalogVirtualCatalogRulesDataSetSchema	Schema description for CatalogVirtualCatalogRulesDataSet.
	CatalogXmlValidationException	The exception that is thrown when validation of an XML file fails.
	Category	Used to manage a category in a catalog. This class is an abstract class derived from CatalogItem class.
	CategoryCollection	A collection of categories in a virtual catalog or a base catalog. This class cannot be inherited.
	CategoryConfiguration	Specifies the pre-loaded configuration of a Category object, including it's Child categories and products.
	CategoryNullPriceException	The exception that is thrown when using category pricing and a null category price exists.
	CollectionConfiguration	CollectionConfiguration xml-serializable data-object.
	CommonSearchOptions	An abstract class. Provides properties that customize the catalog search results when performing searches on one or more catalogs.
	DataSetBasedCollection<(Of <(TObject, TDataSet>)>)	An abstract class; DataSetBased Collection of items based on a dataset.
	EntityInUseException	The exception that is thrown when an entity is in use and an attempt to delete the entity occurs.
	EntityScopeAlreadyExistsException	The exception that is thrown when attempting to add or create a scope that already exists.
	EntityScopeDoesNotExistException	The exception that is thrown when attempting to add or create an entity scope that entity scope does not already exist.
	ExportOptions	Specifies the set of options to use for an inventory export operation.
	ExportProgress	Contains information about the status of the export operation.
	ImportHost	This class is used to import a catalog from the host server. This class cannot be inherited.
	ImportOptions	Specifies the set of options to use for a catalog import operation.
	ImportProgress	Contains information about the status of the import operation.
	InvalidCatalogOperationException	The exception that is thrown when an invalid operation is attempted.
	InvalidDBCatalogSchemaException	The exception that is thrown when the DB Schema is not compatible with the server version.
	InvalidDefinitionUseException	The exception that is thrown when attempting to specify an invalid definition.
	InvalidObjectException	The exception that is thrown when an object is invalid.
	InvalidPropertyTypeException	The exception that is thrown when an invalid property type is used.
	InvalidRuleException	The exception that is thrown when attempting to specify an invalid rule.
	InvalidSearchHandleException	The exception that is thrown when attempting to operate on a SpecificationSearch object with an invalid handle.
	InvalidSearchOptionException	The exception that is thrown when a search is attempted with invalid search options.
	InvalidSkuException	The exception that is thrown when an invalid Inventory SKU is used.
	InventoryCatalogsDataSetSchema	Schema description for InventoryCatalogsDataSet.
	InventoryQuantityDeltasDataSetSchema	Schema description for InventoryQuantityDeltasDataSet.
	InventorySkusDataSetSchema	Schema description for InventorySkusDataSet.
	JoinTableException	The exception that is thrown when attempting to use a join table with invalid information.
	JoinTableInformation	Stores join information about an external data table or view that is joined to the catalog system.
	LanguageRemoveException	The exception that is thrown when attempting to remove a language which cannot be removed, such as the default language, reporting language, or the last language in the catalog.
	MaximumLimitException	The exception that is thrown when a name contains more characters than allowed in the catalog system.
	MissingCatalogResourceException	The exception that is thrown when a catalog resource is missing.
	MultilingualCatalogObject	An abstract class. The catalog object provides access to the details of a product catalog (base or virtual).
	NoPrimaryParentCategoryException	The exception that is thrown when attempting to set Use Category Pricing on an item with no primary parent category defined.
	ObjectHasChangesException	The exception that is thrown when an operation is attempted on a changed object.
	OperationErrorsDataSet	Access the OperationErrors values in the OperationErrorsDataSet.
	OperationErrorsDataSet..::.OperationError	Allows access to the OperationErrorsDataSet..::.OperationErrorsDataTable table.
	OperationErrorsDataSet..::.OperationErrorChangeEvent	Allows access to the change events of the OperationErrorsDataSet..::.OperationErrorsDataTable table. Provides data for the CatalogDefinitionPropertiesDataSet events.
	OperationErrorsDataSet..::.OperationErrorsDataTable	The data table that contains the Catalog Operation Errors.
	OperationErrorsDataSetSchema	Schema description for OperationErrorsDataSet.
	OperationInProgressException	The exception that is thrown when an operation already in progress causes this operation to fail.
	OperationsProgress	An abstract class containing the progress of a long running operation.
	OperationStatusDataSet	The strongly typed DataSet that is used to access the OperationStatuses in the Catalog system.
	OperationStatusDataSet..::.OperationStatus	Allows access to the OperationStatusDataSet..::.OperationStatusesDataTable table.
	OperationStatusDataSet..::.OperationStatusChangeEvent	Allows access to the change events of the OperationStatusDataSet..::.OperationStatusesDataTable table. Provides data for the CatalogItemsDataSet events.
	OperationStatusDataSet..::.OperationStatusesDataTable	The data table that contains the Operation Statuses.
	OperationStatusDataSetSchema	Schema description for OperationStatusDataSet.
	PricingRule	Represents pricing adjustments.
	PricingRuleCollection	A collection of price rules in a virtual catalog or a base catalog. This class cannot be inherited.
	Product	Used to manage a product in a catalog.
	ProductCatalog	The product catalog object provides access to the details of a product catalog (base or virtual), catalog search and product and category management.
	ProductCatalogCollection	A collection of ProductCatalog objects. This class cannot be inherited.
	ProductCollection	A collection of Product and ProductFamily objects. This class cannot be inherited.
	ProductConfiguration	Configuration of a Product, allows you to specify configuration of variants (ignored for non product family products).
	ProductFamily	Contains the functions specific to a product family in the product catalog system.
	ProductPriceException	The exception that is thrown when the price set for a product is invalid.
	QueryCatalogInfoClass	This class contains items required by the IPipelineComponent Interface.
	RebuildProgress	Contains information about the status of the rebuild operation.
	RegularCatalogProperty	Represents all catalog properties except Enumeration properties.
	RegularProduct	Used to represent a regular product in the catalog system.
	RuleAlreadyExistsException	The exception that is thrown when an attempt is made to add or create a pricing rule or a virtual catalog rule that already exists.
	SearchableObjectCollection<(Of <(TObject, TDataSet>)>)	An object collection which supports searching.
	SearchOptions	Provides properties to customize search results.
	SpecificationSearch	Specification search class encapsulates the search handle and specification search property result concepts previously exposed on the product catalog object.
	SpecificationSearchPropertyResult	(Public Sealed) Represents the result for a property in a specification search.
	StaticCategory	The StaticCategory class manages a static category. A static category is a category to which product catalogs are explicitly added and removed. This class cannot be inherited.
	UpdateClause	Represents an update clause containing the catalog property to update and its value.
	ValidationException	The exception that is thrown on validation when using an invalid value.
	Variant	A variant of a product family. Represents a single product variant in the product catalog system.
	VariantCollection	A collection of variants within the Catalog. This class cannot be inherited.
	VariantConfiguration	Configuration of a Product, allows you to specify configuration of variants (ignored for non product family products).
	VirtualCatalog	A type of product catalog whose data is built from other catalogs.
	VirtualCatalogRule	Used to manage pricing rules in a virtual catalog.
	VirtualCatalogRuleCollection	A collection of virtual catalog inclusion/exclusion rules for this virtual catalog. This class cannot be inherited.
	XmlImportOptions	Specifies the set of options used during an Xml import operation.

Interfaces

	Interface	Description
	ICatalogImport	The interface used when importing a catalog.
	ICatalogRebuild	The interface used when rebuilding a catalog.

Delegates

	Delegate	Description
	CatalogDefinitionPropertiesDataSet..::.CatalogDefinitionPropertyChangeEventHandler	Represents the method that will handle the Change event.
	CatalogDefinitionsDataSet..::.CatalogDefinitionChangeEventHandler	Represents the method that will handle the Change event.
	CatalogEnumerationPropertyValuesDataSet..::.EnumerationPropertyValueChangeEventHandler	Represents the method that will handle the Change event.
	CatalogItemsDataSet..::.CatalogItemChangeEventHandler	Represents the method that will handle the Change event.
	CatalogPricingRulesDataSet..::.PricingRuleChangeEventHandler	Represents the method that will handle the Change event.
	CatalogPropertiesDataSet..::.CatalogPropertyChangeEventHandler	Represents the method that will handle the Change event.
	CatalogRelationshipsDataSet..::.CatalogRelationshipChangeEventHandler	Represents the method that will handle the Change event.
	CatalogsDataSet..::.CatalogChangeEventHandler	Represents the method that will handle the Change event.
	CatalogSetsDataSet..::.CatalogSetChangeEventHandler	Represents the method that will handle the Change event.
	CatalogVirtualCatalogRulesDataSet..::.VirtualCatalogRuleChangeEventHandler	Represents the method that will handle the Change event.
	OperationErrorsDataSet..::.OperationErrorChangeEventHandler	Represents the method that will handle the Change event.
	OperationStatusDataSet..::.OperationStatusChangeEventHandler	Represents the method that will handle the Change event.

Enumerations

	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 has a FlagsAttribute attribute that allows a bitwise combination of its member values.
	CatalogDataType	Specifies the valid data types for catalog properties.
	CatalogDefinitionType	Specifies the catalog definition type.
	CatalogExportFormatType	Specifies the catalog export format.
	CatalogFlags	Specifies catalog flags.
	CatalogJoinType	Specifies the type used to join the catalog tables. Used with JoinTableInformation to specify the type of join to use across the catalog system.
	CatalogOperationsStatus	Specifies the status of a catalog import, export, or rebuild operation.
	CatalogPricingRuleType	Specifies catalog pricing rules.
	DefinitionPropertyType	Specifies the definition property type.
	Descendants	Specifies how descendants will be exported for an expression-based export operation.
	ExportMode	Specifies the export mode.
	ExtensibleEntityType	Specifies the class of entities that can be extended by adding user-defined properties.
	ImportMode	Specifies the catalog import mode.
	ImportOperation	Specifies the catalog import validation mode.
	MaterializationOption	Specifies the materialization parameters used when importing virtual catalogs.
	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.