atg.search.routing.command.search
Class SimilarDocsRequest.DocSetSort

java.lang.Object
  atg.core.util.Enum
      atg.search.routing.command.search.SimilarDocsRequest.DocSetSort

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

SimilarDocsRequest

public static class SimilarDocsRequest.DocSetSort
extends Enum

ATG Search can return categorization feedback about the returned results in the form of a tree. This functionality is controlled by this attribute.

The mode value can be none, which means no categorization feedback tree is constructed. The mode value can be fulltree, which means that a full categorization tree is returned, with all intervening levels, even if they have no direct connection to the results. The mode value can be sparsetree, which means that that a categorization tree is returned, but intervening levels that have no direct connection to the results are omitted. There are several other experimental values for this attribute, but they are not in use. The default value is none. See SearchPropertyEditors.

See Also:

Serialized Form

Nested Class Summary

static class

SimilarDocsRequest.DocSetSort.DocSetSortEditor

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 SimilarDocsRequest.DocSetSort	FULLTREE
static SimilarDocsRequest.DocSetSort	NONE
static SimilarDocsRequest.DocSetSort	SPARSETREE

Method Summary

static SimilarDocsRequest.DocSetSort

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

FULLTREE

public static final SimilarDocsRequest.DocSetSort FULLTREE

SPARSETREE

public static final SimilarDocsRequest.DocSetSort SPARSETREE

NONE

public static final SimilarDocsRequest.DocSetSort NONE

Method Detail

valueOf

public static SimilarDocsRequest.DocSetSort valueOf(java.lang.String pName)