atg.search.routing.command.search
Class ViewDocumentRequest.Return

java.lang.Object
  atg.core.util.Enum
      atg.search.routing.command.search.ViewDocumentRequest.Return

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Enclosing class:

ViewDocumentRequest

public static class ViewDocumentRequest.Return
extends Enum

The Return type determines what the ViewDocument request returns. See SearchPropertyEditors.

See Also:

Serialized Form

Nested Class Summary

static class

ViewDocumentRequest.Return.ReturnEditor

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 ViewDocumentRequest.Return	DOCUMENT return the text of the document.
static ViewDocumentRequest.Return	FIELDOFFSET return the relative offsets into the fields of the source content for the text regions, in the form: field.begin-end,field.begin-end,...
static ViewDocumentRequest.Return	INFORMATION returns a document element as in a regular query.
static ViewDocumentRequest.Return	INSPECT ItemInspect is returned.
static ViewDocumentRequest.Return	LOGONLY The request is logged, but nothing is sent to the engine, and consequently the return is empty.
static ViewDocumentRequest.Return	OFFSET offset - return absolute offsets into source content for text regions, in the form: begin-end,begin-end,...

Method Summary

static ViewDocumentRequest.Return

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

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

DOCUMENT

public static final ViewDocumentRequest.Return DOCUMENT

return the text of the document.

OFFSET

public static final ViewDocumentRequest.Return OFFSET

offset - return absolute offsets into source content for text regions, in the form: begin-end,begin-end,...

FIELDOFFSET

public static final ViewDocumentRequest.Return FIELDOFFSET

return the relative offsets into the fields of the source content for the text regions, in the form: field.begin-end,field.begin-end,...

INFORMATION

public static final ViewDocumentRequest.Return INFORMATION

returns a document element as in a regular query.

LOGONLY

public static final ViewDocumentRequest.Return LOGONLY

The request is logged, but nothing is sent to the engine, and consequently the return is empty.

INSPECT

public static final ViewDocumentRequest.Return INSPECT

ItemInspect is returned.

Method Detail

valueOf

public static ViewDocumentRequest.Return valueOf(java.lang.String pName)

Method to get the enumerated value object for the given string.

Parameters:

pName - String name to lookup.

Returns:

Enum for the given name.