RefinementElement (ATG Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
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
`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
`protected`	`RefinementElement()`

Method Summary
`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