atg.search.routing.command.search
Class BrowseRequest.RecurseDocumentsType

java.lang.Object
  extended by atg.core.util.Enum
      extended by atg.search.routing.command.search.BrowseRequest.RecurseDocumentsType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable
Enclosing class:
BrowseRequest

public static class BrowseRequest.RecurseDocumentsType
extends Enum

A mode value of on means that index items may be collected from child item sets. A mode value of off means that index items may only be collected from the immediate item set, excluding any from child sets. A mode value of empty means the same as off, unless the immediate item set has no documents. The default value is off. See SearchPropertyEditors.

See Also:
Serialized Form

Nested Class Summary
static class BrowseRequest.RecurseDocumentsType.RecurseDocumentsTypeEditor
           
 
Nested classes/interfaces inherited from class atg.core.util.Enum
Enum.EnumEditor, Enum.LocaleEnumEditor
 
Field Summary
static BrowseRequest.RecurseDocumentsType EMPTY
          Same as off, unless the immediate item set has no documents.
static BrowseRequest.RecurseDocumentsType OFF
          Index items may only be collected from the immediate item set, excluding any from child sets.
static BrowseRequest.RecurseDocumentsType ON
          index items may be collected from child item sets
 
Fields inherited from class atg.core.util.Enum
CLASS_VERSION
 
Method Summary
static java.util.Iterator getIterator()
           
static BrowseRequest.RecurseDocumentsType valueOf(java.lang.String pName)
          Method to get the enumerated value object for the given string.
 
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

ON

public static final BrowseRequest.RecurseDocumentsType ON
index items may be collected from child item sets


EMPTY

public static final BrowseRequest.RecurseDocumentsType EMPTY
Same as off, unless the immediate item set has no documents.


OFF

public static final BrowseRequest.RecurseDocumentsType OFF
Index items may only be collected from the immediate item set, excluding any from child sets. This is the default.

Method Detail

getIterator

public static java.util.Iterator getIterator()

valueOf

public static BrowseRequest.RecurseDocumentsType valueOf(java.lang.String pName)
Method to get the enumerated value object for the given string.

Parameters:
pName - String name to lookup.
Returns:
SetSort for the given name.