atg.repository.search.refinement.admin

Class RefinementElement

java.lang.Object

atg.repository.search.refinement.admin.RefinementElement

All Implemented Interfaces:

java.lang.Comparable

public class RefinementElement
extends java.lang.Object
implements java.lang.Comparable

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected java.util.List	mChildElements
protected java.lang.Integer	mDesired
protected java.lang.String	mDisplayFragment
protected java.util.Set	mExclude
protected java.lang.String	mId
protected java.lang.Integer	mIncrement
protected java.lang.String	mLabel
protected java.lang.Integer	mLevels
protected java.lang.Integer	mMaxValues
protected java.lang.Integer	mMinimum
protected java.util.List	mOrder
protected RepositoryItem	mParentRefineElement
protected java.lang.Integer	mPriority
protected java.lang.String	mProperty
protected RefinementPropertyType	mPropertyType
protected RefinementRangeType	mRange
protected java.util.List	mRanges
protected java.lang.Boolean	mRemoveWhenUsed
protected java.lang.Integer	mRound
protected java.util.List	mSelect
protected atg.repository.search.refinement.admin.RefinementSortType	mSort
protected java.lang.String	mType

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RefinementElement()

Method Summary

Modifier and Type	Method and Description
int	compareTo(java.lang.Object p2)
boolean	equals(java.lang.Object obj)
java.util.List	getChildElements()
java.lang.Integer	getDesired()
java.lang.String	getDisplayFragment()
java.util.Set	getExclude()
java.lang.String	getId()
java.lang.Integer	getIncrement()
java.lang.String	getLabel()
java.lang.Integer	getLevels()
java.lang.Integer	getMaxValues()
java.lang.Integer	getMinimum()
java.util.List	getOrder()
RepositoryItem	getParentRefineElement()
java.lang.Integer	getPriority()
java.lang.String	getProperty()
RefinementPropertyType	getPropertyType()
RefinementRangeType	getRange()
java.util.List	getRanges()
java.lang.Integer	getRound()
java.util.List	getSelect()
atg.repository.search.refinement.admin.RefinementSortType	getSort()
java.lang.String	getType()
java.lang.String	getXMLView()
int	hashCode()
java.lang.Boolean	removeWhenUsed()
void	setChildElements(java.util.List pChildElements)
void	setDesired(java.lang.Integer pDesired)
void	setDisplayFragment(java.lang.String pDisplayFragment)
void	setExclude(java.util.Set pExclude)
void	setId(java.lang.String pId)
void	setIncrement(java.lang.Integer pIncrement)
void	setLabel(java.lang.String pLabel)
void	setLevels(java.lang.Integer pLevels)
void	setMaxValues(java.lang.Integer pMaxValues)
void	setMinimum(java.lang.Integer pMinimum)
void	setOrder(java.util.List pOrder)
void	setParentRefineElement(RepositoryItem pParentRefineElement)
void	setPriority(java.lang.Integer pPriority)
void	setProperty(java.lang.String pProperty)
void	setPropertyType(RefinementPropertyType pPropertyType)
void	setRange(RefinementRangeType pRange)
void	setRanges(java.util.List pRanges)
void	setRemoveWhenUsed(java.lang.Boolean pRemoveWhenUsed)
void	setRound(java.lang.Integer pRound)
void	setSelect(java.util.List pSelect)
void	setSort(atg.repository.search.refinement.admin.RefinementSortType pSort)
void	setType(java.lang.String pType)
java.lang.String	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

mId

protected java.lang.String mId

mType

protected java.lang.String mType

mProperty

protected java.lang.String mProperty

mPropertyType

protected RefinementPropertyType mPropertyType

mLabel

protected java.lang.String mLabel

mRange

protected RefinementRangeType mRange

mDesired

protected java.lang.Integer mDesired

mMinimum

protected java.lang.Integer mMinimum

mIncrement

protected java.lang.Integer mIncrement

mRanges

protected java.util.List mRanges

mSort

protected atg.repository.search.refinement.admin.RefinementSortType mSort

mOrder

protected java.util.List mOrder

mLevels

protected java.lang.Integer mLevels

mSelect

protected java.util.List mSelect

mParentRefineElement

protected RepositoryItem mParentRefineElement

mChildElements

protected java.util.List mChildElements

mPriority

protected java.lang.Integer mPriority

mRemoveWhenUsed

protected java.lang.Boolean mRemoveWhenUsed

mDisplayFragment

protected java.lang.String mDisplayFragment

mMaxValues

protected java.lang.Integer mMaxValues

mRound

protected java.lang.Integer mRound

mExclude

protected java.util.Set mExclude

Constructor Detail

RefinementElement

protected RefinementElement()

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)

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String pProperty)

getPropertyType

public RefinementPropertyType getPropertyType()

setPropertyType

public void setPropertyType(RefinementPropertyType pPropertyType)

getLabel

public java.lang.String getLabel()

setLabel

public void setLabel(java.lang.String pLabel)

getRange

public RefinementRangeType getRange()

setRange

public void setRange(RefinementRangeType pRange)

getDesired

public java.lang.Integer getDesired()

setDesired

public void setDesired(java.lang.Integer pDesired)

getMinimum

public java.lang.Integer getMinimum()

setMinimum

public void setMinimum(java.lang.Integer pMinimum)

getIncrement

public java.lang.Integer getIncrement()

setIncrement

public void setIncrement(java.lang.Integer pIncrement)

getRanges

public java.util.List getRanges()

setRanges

public void setRanges(java.util.List pRanges)

getSort

public atg.repository.search.refinement.admin.RefinementSortType getSort()

setSort

public void setSort(atg.repository.search.refinement.admin.RefinementSortType pSort)

getOrder

public java.util.List getOrder()

setOrder

public void setOrder(java.util.List pOrder)

getLevels

public java.lang.Integer getLevels()

setLevels

public void setLevels(java.lang.Integer pLevels)

getSelect

public java.util.List getSelect()

setSelect

public void setSelect(java.util.List pSelect)

getParentRefineElement

public RepositoryItem getParentRefineElement()

setParentRefineElement

public void setParentRefineElement(RepositoryItem pParentRefineElement)

getChildElements

public java.util.List getChildElements()

setChildElements

public void setChildElements(java.util.List pChildElements)

getPriority

public java.lang.Integer getPriority()

setPriority

public void setPriority(java.lang.Integer pPriority)

removeWhenUsed

public java.lang.Boolean removeWhenUsed()

setRemoveWhenUsed

public void setRemoveWhenUsed(java.lang.Boolean pRemoveWhenUsed)

getDisplayFragment

public java.lang.String getDisplayFragment()

setDisplayFragment

public void setDisplayFragment(java.lang.String pDisplayFragment)

getMaxValues

public java.lang.Integer getMaxValues()

setMaxValues

public void setMaxValues(java.lang.Integer pMaxValues)

getRound

public java.lang.Integer getRound()

setRound

public void setRound(java.lang.Integer pRound)

getExclude

public java.util.Set getExclude()

setExclude

public void setExclude(java.util.Set pExclude)

getXMLView

public java.lang.String getXMLView()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object p2)

Specified by:

compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object