org.apache.wink.common.model.opensearch
Enum OpenSearchParameter.OpenSearchParams

java.lang.Object
  java.lang.Enum<OpenSearchParameter.OpenSearchParams>
      org.apache.wink.common.model.opensearch.OpenSearchParameter.OpenSearchParams

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OpenSearchParameter.OpenSearchParams>

Enclosing class:

OpenSearchParameter

public static enum OpenSearchParameter.OpenSearchParams
extends java.lang.Enum<OpenSearchParameter.OpenSearchParams>

OpenSearch 1.1 parameters

Enum Constant Summary

count
Replaced with the number of search results per page desired by the search client.

inputEncoding
Replaced with a string that indicates that the search client is performing the search request encoded with the specified character encoding.

language
Replaced with a string that indicates that the search client desires search results in the specified language.

outputEncoding
Replaced with a string that indicates that the search client desires a search response encoding with the specified character encoding.

searchTerms
Replaced with the keyword or keywords desired by the search client.

startPage
Replaced with the page number of the set of search results desired by the search client.

Method Summary

static OpenSearchParameter.OpenSearchParams	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OpenSearchParameter.OpenSearchParams[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

searchTerms

public static final OpenSearchParameter.OpenSearchParams searchTerms

Replaced with the keyword or keywords desired by the search client. Restrictions: The value must be URL-encoded.

count

public static final OpenSearchParameter.OpenSearchParams count

Replaced with the number of search results per page desired by the search client.

startPage

public static final OpenSearchParameter.OpenSearchParams startPage

Replaced with the page number of the set of search results desired by the search client. Restrictions: The value must be an integer.

language

public static final OpenSearchParameter.OpenSearchParams language

Replaced with a string that indicates that the search client desires search results in the specified language.

inputEncoding

public static final OpenSearchParameter.OpenSearchParams inputEncoding

Replaced with a string that indicates that the search client is performing the search request encoded with the specified character encoding.

outputEncoding

public static final OpenSearchParameter.OpenSearchParams outputEncoding

Replaced with a string that indicates that the search client desires a search response encoding with the specified character encoding.

Method Detail

values

public static OpenSearchParameter.OpenSearchParams[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OpenSearchParameter.OpenSearchParams c : OpenSearchParameter.OpenSearchParams.values())
    System.out.println(c);

Returns:

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

valueOf

public static OpenSearchParameter.OpenSearchParams valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null