atg.search.routing.command.search
Class BrowseRequest.AncestryType

java.lang.Object
  atg.core.util.Enum
      atg.search.routing.command.search.BrowseRequest.AncestryType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

BrowseRequest

public static class BrowseRequest.AncestryType
extends Enum

A value of direct means that the parent and direct ancestors of the starting item set will be returned. A value of full means that that all item sets within the sub-tree containing the starting set will be returned (e.g. /Topics sub-tree if the starting set is a category). A value of none means no ancestry information is returned. The default value is none. See SearchPropertyEditors.

See Also:

Serialized Form

Nested Class Summary

static class

BrowseRequest.AncestryType.AncestryTypeEditor

Nested classes/interfaces inherited from class atg.core.util.Enum

Enum.EnumEditor, Enum.LocaleEnumEditor

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static BrowseRequest.AncestryType	DIRECT the parent and direct ancestors of the starting item set will be returned
static BrowseRequest.AncestryType	FULL all item sets within the sub-tree containing the starting set will be returned (e.g.
static BrowseRequest.AncestryType	NONE no ancestry information is returned

Method Summary

static java.util.Iterator	getIterator()
static BrowseRequest.AncestryType	valueOf(java.lang.String pName)

Methods inherited from class atg.core.util.Enum

compareTo, getEnumClassInfo, getOrdinal, iterator, iterator, lookup, lookup, lookup, lookup, readResolve, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

NONE

public static final BrowseRequest.AncestryType NONE

no ancestry information is returned

FULL

public static final BrowseRequest.AncestryType FULL

all item sets within the sub-tree containing the starting set will be returned (e.g. /Topics sub-tree if the starting set is a category)

DIRECT

public static final BrowseRequest.AncestryType DIRECT

the parent and direct ancestors of the starting item set will be returned

Method Detail

getIterator

public static java.util.Iterator getIterator()

valueOf

public static BrowseRequest.AncestryType valueOf(java.lang.String pName)