Enum Class QueryManager.QueryView

All Implemented Interfaces:

Serializable, Comparable<QueryManager.QueryView>, Constable

Enclosing interface:

QueryManager

• Nested Class Summary

  Nested classes/interfaces inherited from class java.lang.Enum

  Enum.EnumDesc<E extends Enum<E>>

• Enum Constant Summary

  Enum Constants
  Enum Constant

  Description

  ALL

  All views that the query can produce.

  DEFAULT

  The view specified by the query options.

  FACETS

  Values from different constraints for the matched documents.

  METADATA

  Basic summary information about the matched documents.

  RESULTS

  A list of result documents with snippets, extracted metadata, and so on.

• Method Summary

  All MethodsStatic MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  static QueryManager.QueryView

  valueOf(String name)

  Returns the enum constant of this class with the specified name.

  static QueryManager.QueryView[]

  values()

  Returns an array containing the constants of this enum class, in the order they are declared.

  Methods inherited from class java.lang.Enum

  clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

  Methods inherited from class java.lang.Object

  getClass, notify, notifyAll, wait, wait, wait

• Enum Constant Details

  • DEFAULT

    public static final QueryManager.QueryView DEFAULT
    The view specified by the query options.

  • RESULTS

    public static final QueryManager.QueryView RESULTS
    A list of result documents with snippets, extracted metadata, and so on.

  • FACETS

    public static final QueryManager.QueryView FACETS
    Values from different constraints for the matched documents.

  • METADATA

    public static final QueryManager.QueryView METADATA
    Basic summary information about the matched documents.

  • ALL

    public static final QueryManager.QueryView ALL
    All views that the query can produce.

• Method Details

  • values

    public static QueryManager.QueryView[] values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Returns:

    an array containing the constants of this enum class, in the order they are declared

  • valueOf

    public static QueryManager.QueryView valueOf(String name)
    Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

    Parameters:

    name - the name of the enum constant to be returned.

    Returns:

    the enum constant with the specified name

    Throws:

    IllegalArgumentException - if this enum class has no constant with the specified name

    NullPointerException - if the argument is null

Copyright (c) 2010-2026 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.