atg.commerce.search.refinement.admin

Class CommerceRefinementConfiguration

java.lang.Object

atg.repository.search.refinement.admin.RefinementConfiguration

atg.commerce.search.refinement.admin.CommerceRefinementConfiguration

Direct Known Subclasses:

CustomRefinementConfiguration

public class CommerceRefinementConfiguration
extends RefinementConfiguration

Well defined holder class for a 'commerceRefinementConfiguration' repository item's properties. This class extends the base RefinementConfiguration class. This class provides getter and setter methods for each of the properties in a 'commerceRefinementConfiguration' item descriptor. It can be populated from a 'commerceRefinementConfiguration' repository item by creating a new CommerceRefinementConfiguration object and then calling the populateCommerceRefinementConfiguration() method in the CommerceRefinementConfigurationPropertyManager. Also a MutableRepositoryItem can be populated with values from an object of this class by calling the populateRepositoryItem() method in the CommerceRefinementConfigurationPropertyManager.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.lang.Boolean	mCanChildrenInherit
protected java.lang.Boolean	mCanInheritFromCategory
protected java.lang.Boolean	mCanInheritFromGlobal
protected java.util.List	mGeneratedRefineElements
protected java.lang.Boolean	mIsGlobal

Fields inherited from class atg.repository.search.refinement.admin.RefinementConfiguration

mId, mRefineConfigName, mRefineElements, mSortOptions, mType

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	canChildrenInherit()
java.lang.Boolean	canInheritFromCategory()
java.lang.Boolean	canInheritFromGlobal()
java.util.List	getGeneratedRefineElements()
java.util.List	getQueryRefinements() Returns the list of refinements associated with the refine config that can be used in searches
java.lang.String	getXMLView()
java.lang.Boolean	isGlobal()
void	setCanChildrenInherit(java.lang.Boolean pCanChildrenInherit)
void	setCanInheritFromCategory(java.lang.Boolean pCanInheritFromCategory)
void	setCanInheritFromGlobal(java.lang.Boolean pCanInheritFromGlobal)
void	setGeneratedRefineElements(java.util.List pGeneratedRefineElements)
void	setIsGlobal(java.lang.Boolean pIsGlobal)
java.lang.String	toString()

Methods inherited from class atg.repository.search.refinement.admin.RefinementConfiguration

addRefineElement, addSortOption, getId, getRefineConfigName, getRefineElements, getSortOptions, getType, removeRefineElement, removeSortOption, setId, setRefineConfigName, setRefineElements, setSortOptions, setType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mCanInheritFromCategory

protected java.lang.Boolean mCanInheritFromCategory

mCanInheritFromGlobal

protected java.lang.Boolean mCanInheritFromGlobal

mCanChildrenInherit

protected java.lang.Boolean mCanChildrenInherit

mIsGlobal

protected java.lang.Boolean mIsGlobal

mGeneratedRefineElements

protected java.util.List mGeneratedRefineElements

Method Detail

canInheritFromCategory

public java.lang.Boolean canInheritFromCategory()

setCanInheritFromCategory

public void setCanInheritFromCategory(java.lang.Boolean pCanInheritFromCategory)

canInheritFromGlobal

public java.lang.Boolean canInheritFromGlobal()

setCanInheritFromGlobal

public void setCanInheritFromGlobal(java.lang.Boolean pCanInheritFromGlobal)

canChildrenInherit

public java.lang.Boolean canChildrenInherit()

setCanChildrenInherit

public void setCanChildrenInherit(java.lang.Boolean pCanChildrenInherit)

isGlobal

public java.lang.Boolean isGlobal()

setIsGlobal

public void setIsGlobal(java.lang.Boolean pIsGlobal)

getGeneratedRefineElements

public java.util.List getGeneratedRefineElements()

setGeneratedRefineElements

public void setGeneratedRefineElements(java.util.List pGeneratedRefineElements)

getQueryRefinements

public java.util.List getQueryRefinements()

Returns the list of refinements associated with the refine config that can be used in searches

Overrides:

getQueryRefinements in class RefinementConfiguration

Returns:

A List of refinements.

getXMLView

public java.lang.String getXMLView()

Overrides:

getXMLView in class RefinementConfiguration

toString

public java.lang.String toString()

Overrides:

toString in class RefinementConfiguration