Package com.luciad.opensearch.model

Enum Class TLcdOpenSearchQuery.Role

java.lang.Object

java.lang.Enum<TLcdOpenSearchQuery.Role>

com.luciad.opensearch.model.TLcdOpenSearchQuery.Role

All Implemented Interfaces:

Serializable, Comparable<TLcdOpenSearchQuery.Role>, Constable

Enclosing class:

TLcdOpenSearchQuery

public static enum TLcdOpenSearchQuery.Role
extends Enum<TLcdOpenSearchQuery.Role>

Since:

2017.0

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
CORRECTION	Represents a search query that can be performed to improve the result set, such as with a spelling correction.
EXAMPLE	Represents a search query that can be performed to demonstrate the search engine.
RELATED	Represents a search query that can be performed to retrieve similar but different search results.
REQUEST	Represents the search query that can be performed to retrieve the same set of search results.
SUBSET	Represents a search query that will narrow the current set of search results.
SUPERSET	Represents a search query that will broaden the current set of search results.

Method Summary

Modifier and Type	Method	Description
static TLcdOpenSearchQuery.Role	fromValue(String aValue)
String	toString()
static String	toValue(TLcdOpenSearchQuery.Role aValue)
String	value()
static TLcdOpenSearchQuery.Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TLcdOpenSearchQuery.Role[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUEST

public static final TLcdOpenSearchQuery.Role REQUEST

Represents the search query that can be performed to retrieve the same set of search results.

EXAMPLE

public static final TLcdOpenSearchQuery.Role EXAMPLE

Represents a search query that can be performed to demonstrate the search engine.

RELATED

public static final TLcdOpenSearchQuery.Role RELATED

Represents a search query that can be performed to retrieve similar but different search results.

CORRECTION

public static final TLcdOpenSearchQuery.Role CORRECTION

Represents a search query that can be performed to improve the result set, such as with a spelling correction.

SUBSET

public static final TLcdOpenSearchQuery.Role SUBSET

Represents a search query that will narrow the current set of search results.

SUPERSET

public static final TLcdOpenSearchQuery.Role SUPERSET

Represents a search query that will broaden the current set of search results.

Method Details

values

public static TLcdOpenSearchQuery.Role[] 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 TLcdOpenSearchQuery.Role 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

value

public String value()

toString

public String toString()

Overrides:

toString in class Enum<TLcdOpenSearchQuery.Role>

fromValue

public static TLcdOpenSearchQuery.Role fromValue(String aValue)

toValue

public static String toValue(TLcdOpenSearchQuery.Role aValue)