atg.repository.search.refinement.admin
Class RefinementConfiguration

java.lang.Object
  atg.repository.search.refinement.admin.RefinementConfiguration

Direct Known Subclasses:

CommerceRefinementConfiguration

public class RefinementConfiguration
extends java.lang.Object

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

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected java.lang.String	mId
protected java.lang.String	mRefineConfigName
protected java.util.List	mRefineElements
protected java.util.Set	mSortOptions
protected java.lang.String	mType

Constructor Summary

protected

RefinementConfiguration()

Method Summary

void	addRefineElement(RepositoryItem pRefineElement)
void	addSortOption(RepositoryItem pSortOption)
java.lang.String	getId()
java.util.List	getQueryRefinements() Returns the list of refinements associated with the refine config that can be used in searches
java.lang.String	getRefineConfigName()
java.util.List	getRefineElements()
java.util.Set	getSortOptions()
java.lang.String	getType()
java.lang.String	getXMLView()
void	removeRefineElement(RepositoryItem pRefineElement)
void	removeSortOption(RepositoryItem pSortOption)
void	setId(java.lang.String pId)
void	setRefineConfigName(java.lang.String pRefineConfigName)
void	setRefineElements(java.util.List pRefineElements)
void	setSortOptions(java.util.Set pSortOptions)
void	setType(java.lang.String pType)
java.lang.String	toString()

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

mId

protected java.lang.String mId

mType

protected java.lang.String mType

mRefineElements

protected java.util.List mRefineElements

mRefineConfigName

protected java.lang.String mRefineConfigName

mSortOptions

protected java.util.Set mSortOptions

Constructor Detail

RefinementConfiguration

protected RefinementConfiguration()

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String pId)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String pType)

getRefineElements

public java.util.List getRefineElements()

setRefineElements

public void setRefineElements(java.util.List pRefineElements)

addRefineElement

public void addRefineElement(RepositoryItem pRefineElement)

removeRefineElement

public void removeRefineElement(RepositoryItem pRefineElement)

getRefineConfigName

public java.lang.String getRefineConfigName()

setRefineConfigName

public void setRefineConfigName(java.lang.String pRefineConfigName)

getSortOptions

public java.util.Set getSortOptions()

setSortOptions

public void setSortOptions(java.util.Set pSortOptions)

addSortOption

public void addSortOption(RepositoryItem pSortOption)

removeSortOption

public void removeSortOption(RepositoryItem pSortOption)

getQueryRefinements

public java.util.List getQueryRefinements()

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

Returns:

A List of refinements.

getXMLView

public java.lang.String getXMLView()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object