Package com.saperion.rs.federatedsearch

Enum Class FederatedSearch.ConfigParameter

java.lang.Object

java.lang.Enum<FederatedSearch.ConfigParameter>

com.saperion.rs.federatedsearch.FederatedSearch.ConfigParameter

All Implemented Interfaces:

Serializable, Comparable<FederatedSearch.ConfigParameter>, Constable

Enclosing class:

FederatedSearch

public static enum FederatedSearch.ConfigParameter
extends Enum<FederatedSearch.ConfigParameter>

Configuration parameter used by this JAX-RS resource.

Author:

sts

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
ARCHIVE	The name of the DDC archive to be used by this federated search feed.
DESCRIPTION	The description of the federated search feed.
DESCRIPTION_FIELD	The DDC field to be used as the result's description.
GLOBAL_QUERY	The global query of the federated search feed.
GLOBAL_QUERY_FIELD	The global query field of the federated search feed.
NAME	The name of the federated search feed.
PUBLISHED_FIELD	The DDC field to be used as the result's published date.
QUERY_SIZE	The size of query results of the federated search feed.
QUERY_STRATEGY	The query strategy to build HQL queries from the users query.
SPECIAL_QUERY	The special query of the federated search feed.
TAGS_FIELD	The DDC field to be used as the result's tags.
TITLE_FIELD	The DDC field to be used as the result's title.

Method Summary

Modifier and Type	Method	Description
static FederatedSearch.ConfigParameter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FederatedSearch.ConfigParameter[]	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

NAME

public static final FederatedSearch.ConfigParameter NAME

The name of the federated search feed.

DESCRIPTION

public static final FederatedSearch.ConfigParameter DESCRIPTION

The description of the federated search feed.

ARCHIVE

public static final FederatedSearch.ConfigParameter ARCHIVE

The name of the DDC archive to be used by this federated search feed.

GLOBAL_QUERY

public static final FederatedSearch.ConfigParameter GLOBAL_QUERY

The global query of the federated search feed.

SPECIAL_QUERY

public static final FederatedSearch.ConfigParameter SPECIAL_QUERY

The special query of the federated search feed.

GLOBAL_QUERY_FIELD

public static final FederatedSearch.ConfigParameter GLOBAL_QUERY_FIELD

The global query field of the federated search feed.

QUERY_SIZE

public static final FederatedSearch.ConfigParameter QUERY_SIZE

The size of query results of the federated search feed.

TITLE_FIELD

public static final FederatedSearch.ConfigParameter TITLE_FIELD

The DDC field to be used as the result's title.

DESCRIPTION_FIELD

public static final FederatedSearch.ConfigParameter DESCRIPTION_FIELD

The DDC field to be used as the result's description.

PUBLISHED_FIELD

public static final FederatedSearch.ConfigParameter PUBLISHED_FIELD

The DDC field to be used as the result's published date.

TAGS_FIELD

public static final FederatedSearch.ConfigParameter TAGS_FIELD

The DDC field to be used as the result's tags.

QUERY_STRATEGY

public static final FederatedSearch.ConfigParameter QUERY_STRATEGY

The query strategy to build HQL queries from the users query.

Method Details

values

public static FederatedSearch.ConfigParameter[] 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 FederatedSearch.ConfigParameter 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