citysdk.tourism.client.terms
Enum ParameterTerms

java.lang.Object
  java.lang.Enum<ParameterTerms>
      citysdk.tourism.client.terms.ParameterTerms

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ParameterTerms>

public enum ParameterTerms
extends java.lang.Enum<ParameterTerms>

The available terms for used for Parameter. Such parameters are also valid to use for HypermediaLink.

Author:

Pedro Cruz

Enum Constant Summary

BASE
A poi base

CATEGORY
The search parameter using categories

CODE
The search parameter using code

COMPLETE
The search parameter using complete

COORDS
The search parameter using coords

EVENTS
Used for category list values

ID
A poi id

LIMIT
The search parameter using limit

LIST
The search parameter using list

MINIMAL
The search parameter using minimal

NAME
The search parameter using name

OFFSET
The search parameter using offset

POIS
Used for category list values

RELATION
The search parameter using relations

ROUTES
Used for category list values

SEARCH_PARAMETERS
Just used to group the search parameters

TAG
The search parameter using tags

TIME
The search parameter using time

Method Summary

boolean	equalsTerm(java.lang.String term)
java.util.List<java.lang.String>	getChildren()
java.lang.String	getTerm()
boolean	hasChildren()
static ParameterTerms	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ParameterTerms[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POIS

public static final ParameterTerms POIS

Used for category list values

EVENTS

public static final ParameterTerms EVENTS

Used for category list values

ROUTES

public static final ParameterTerms ROUTES

Used for category list values

SEARCH_PARAMETERS

public static final ParameterTerms SEARCH_PARAMETERS

Just used to group the search parameters

BASE

public static final ParameterTerms BASE

A poi base

ID

public static final ParameterTerms ID

A poi id

CATEGORY

public static final ParameterTerms CATEGORY

The search parameter using categories

TAG

public static final ParameterTerms TAG

The search parameter using tags

COMPLETE

public static final ParameterTerms COMPLETE

The search parameter using complete

MINIMAL

public static final ParameterTerms MINIMAL

The search parameter using minimal

COORDS

public static final ParameterTerms COORDS

The search parameter using coords

CODE

public static final ParameterTerms CODE

The search parameter using code

LIMIT

public static final ParameterTerms LIMIT

The search parameter using limit

OFFSET

public static final ParameterTerms OFFSET

The search parameter using offset

NAME

public static final ParameterTerms NAME

The search parameter using name

TIME

public static final ParameterTerms TIME

The search parameter using time

RELATION

public static final ParameterTerms RELATION

The search parameter using relations

LIST

public static final ParameterTerms LIST

The search parameter using list

Method Detail

values

public static ParameterTerms[] 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 (ParameterTerms c : ParameterTerms.values())
    System.out.println(c);

Returns:

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

valueOf

public static ParameterTerms 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

getChildren

public java.util.List<java.lang.String> getChildren()

hasChildren

public boolean hasChildren()

equalsTerm

public boolean equalsTerm(java.lang.String term)

getTerm

public java.lang.String getTerm()