atg.commerce.search.refinement.custom
Class CatalogFacet

java.lang.Object
  atg.repository.search.refinement.Facet
      atg.repository.search.refinement.RefinementFacet
          atg.commerce.search.refinement.custom.CatalogFacet

public class CatalogFacet
extends atg.repository.search.refinement.RefinementFacet

Represents a catalog-wide refinement element. Extends the RefinementFacet by providing a lazy lookup method to retrieve the catalog's repository item.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mCatalogId
protected RepositoryItem	mCatalogItem
protected CustomCatalogTools	mCatalogTools

Fields inherited from class atg.repository.search.refinement.RefinementFacet

mFacetManager, mId, mRefinement, mRefinementElement

Constructor Summary

CatalogFacet(RepositoryItem pItem, FacetManager pFacetManager)
Constructor method that can be used when we already have the repository item for the facet.

CatalogFacet(java.lang.String pId, FacetManager pFacetManager)
Constructor method

Method Summary

java.lang.String	getCatalogId()
RepositoryItem	getCatalogItem() Gets the catalog's repository item, retrieving this from the product catalog if we don't already have this.
CustomCatalogTools	getCatalogTools()
void	setCatalogId(java.lang.String pCatalogId)
void	setCatalogItem(RepositoryItem pCatalogItem)
void	setCatalogTools(CustomCatalogTools pCatalogTools)

Methods inherited from class atg.repository.search.refinement.RefinementFacet

getDebug, getFacetManager, getId, getLabel, getRefinement, getRefinementElement, getRefinementElement, getRepositoryItem, setFacetManager, setId, setRefinement, setRefinementElement

Methods inherited from class atg.repository.search.refinement.Facet

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mCatalogItem

protected RepositoryItem mCatalogItem

mCatalogId

protected java.lang.String mCatalogId

mCatalogTools

protected CustomCatalogTools mCatalogTools

Constructor Detail

CatalogFacet

public CatalogFacet(java.lang.String pId,
                    FacetManager pFacetManager)

Constructor method

Parameters:

pId - The ID of the refineElement RepositoryItem

pFacetManager - The FacetManager instance used to query the repository.

CatalogFacet

public CatalogFacet(RepositoryItem pItem,
                    FacetManager pFacetManager)
             throws atg.repository.search.refinement.FacetException

Constructor method that can be used when we already have the repository item for the facet.

Parameters:

pItem - refineElement Repository Item

pFacetManager - The FacetManager instance used to query the repository.

Throws:

atg.repository.search.refinement.FacetException - for problems getting the RefinementElement

Method Detail

getCatalogItem

public RepositoryItem getCatalogItem()
                              throws atg.repository.search.refinement.FacetException

Gets the catalog's repository item, retrieving this from the product catalog if we don't already have this.

Returns:

RepositoryItem for this catalog

Throws:

atg.repository.search.refinement.FacetException

setCatalogItem

public void setCatalogItem(RepositoryItem pCatalogItem)

getCatalogId

public java.lang.String getCatalogId()

setCatalogId

public void setCatalogId(java.lang.String pCatalogId)

getCatalogTools

public CustomCatalogTools getCatalogTools()

setCatalogTools

public void setCatalogTools(CustomCatalogTools pCatalogTools)