ProductCatalog Class (BCL)

Represents a catalog in the Commerce Server 2002 Product Catalog System. A ProductCatalog object should be referenced only on the page in which it was created.

System.Object
**** Microsoft.CommerceServer.Runtime.Catalog.ProductCatalog

Protected Instance Constructor

Constructor Description
ProductCatalog Constructor(String, CatalogContext) Creates a new instance of the ProductCatalog class.

 

Public Instance Methods

Method Description
AddSpecificationSearchClause(String, String) Adds a clause to a specification search handle and returns the updated handle.
BeginSpecificationSearch(String, SpecificationSearchPropertyResult[]) Begins a specification search of the catalog and get the property values available for specification.
Dispose Releases the resources used by this object.
GetCatalogAttributes Gets all the attributes of the catalog.
GetCategory(String) Retrieves a Category object from the catalog.
GetProduct(String) Retrieves a Product object from the catalog.
GetProductVariant(String, String) Retrieves the information for a product variant.
GetRootCategories(CatalogSearchOptions, Int32) Gets the root categories in the catalog and returns the results according to the searchOptionsparameter.
GetRootCategories(CatalogSearchOptions) Gets the root categories in the catalog and returns the results according to the searchOptionsparameter.
GetRootCategories Gets the root categories in the catalog and returns the results according to the searchOptionsparameter.
GetRootProducts(CatalogSearchOptions, Int32) Gets the root products in the catalog and returns the results according to the searchOptionsparameter.
GetRootProducts(CatalogSearchOptions) Gets the root products in the catalog and returns the results according to the searchOptionsparameter.
GetRootProducts Gets the root products in the catalog and returns the results according to the searchOptionsparameter.
GetSpecificationSearchClauses(String) Gets the array of specification search clauses represented by the specification search handle.
GuaranteedSpecificationSearch(String, SpecificationSearchPropertyResult[], CatalogSearchOptions, Int32) Performs a specification search guaranteed to return results if any products exist in the category being searched. The updated property values are returned through the propertyValuesparameter.
GuaranteedSpecificationSearch(String, SpecificationSearchPropertyResult[], CatalogSearchOptions) Performs a specification search guaranteed to return results if any products exist in the category being searched. The updated property values are returned through the propertyValuesparameter.
GuaranteedSpecificationSearch(String, SpecificationSearchPropertyResult[]) Performs a specification search guaranteed to return results if any products exist in the category being searched. The updated property values are returned through the propertyValuesparameter.
PerformSpecificationSearch(String, SpecificationSearchPropertyResult[], CatalogSearchOptions, Int32) Performs a specification search and returns the matching results. The updated property values are returned through the propertyValuesparameter.
PerformSpecificationSearch(String, SpecificationSearchPropertyResult[], CatalogSearchOptions) Performs a specification search and returns the matching results. The updated property values are returned through the propertyValuesparameter.
PerformSpecificationSearch(String, SpecificationSearchPropertyResult[]) Performs a specification search and returns the matching results. The updated property values are returned through the propertyValuesparameter.
RemoveSpecificationSearchClause(String) Removes the last specification search clause from the search handle.

 

Public Instance Properties

Property Description
ActiveLanguage Gets language in which data returned by this catalog object should be returned.
CatalogContext Gets the CatalogContext object that was used to create this ProductCatalog object.
DebugContext Gets the DebugContext object for the CatalogContext object that was used to create this ProductCatalog object.
DefaultLanguage Gets the default language for this catalog.
IdentifyingProductProperty Gets the name of the property that identifies products in this catalog.
IdentifyingVariantProperty Gets the name of the property that identifies variants in this catalog .
Languages Gets all of the available languages for this catalog as an array of strings.
Name Gets the name of the catalog.
PropertyNames Gets the names of all properties defined for the catalog
SpecificationSearchableCategories Gets a list of property names for properties that are searchable by the SpecificationSearch objects.

 

Protected Instance Constructor

Method Description
CheckState Verifies that the object has not already been disposed.
Dispose(Boolean) Releases the unmanaged resources used by this object and optionally releases the managed resources.

 

Remarks

There are no public constructors for the ProductCatalog object.

Requirements

Namespace: Microsoft.CommerceServer.Runtime.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Microsoft.CommerceServer.Runtime.dll

Copyright © 2005 Microsoft Corporation.
All rights reserved.