ca.uhn.fhir.rest.api

Enum RestSearchParameterTypeEnum

java.lang.Object

java.lang.Enum<RestSearchParameterTypeEnum>

ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum

All Implemented Interfaces:

Serializable, Comparable<RestSearchParameterTypeEnum>

public enum RestSearchParameterTypeEnum
extends Enum<RestSearchParameterTypeEnum>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPOSITE Code Value: composite A composite search parameter that combines a search on two values together.
DATE Code Value: date Search parameter is on a date/time.
HAS _has parameter
NUMBER Code Value: number Search parameter SHALL be a number (a whole number, or a decimal).
QUANTITY Code Value: quantity A search parameter that searches on a quantity.
REFERENCE Code Value: reference A reference to another resource.
STRING Code Value: string Search parameter is a simple string, like a name part.
TOKEN Code Value: token Search parameter on a coded element or identifier.
URI Code Value: quantity A search parameter that searches on a quantity.

Field Summary

Fields

Modifier and Type	Field and Description
static IValueSetEnumBinder<RestSearchParameterTypeEnum>	VALUESET_BINDER Converts codes to their respective enumerated values
static String	VALUESET_IDENTIFIER Identifier for this Value Set: http://hl7.org/fhir/vs/search-param-type
static String	VALUESET_NAME Name for this Value Set: SearchParamType

Method Summary

Modifier and Type	Method and Description
static RestSearchParameterTypeEnum	forCode(String theCode) Returns the enumerated value associated with this code
String	getCode() Returns the code associated with this enumerated value
String	getSystem() Returns the code system associated with this enumerated value
static RestSearchParameterTypeEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static RestSearchParameterTypeEnum[]	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

NUMBER

public static final RestSearchParameterTypeEnum NUMBER

Code Value: number Search parameter SHALL be a number (a whole number, or a decimal).

DATE

public static final RestSearchParameterTypeEnum DATE

Code Value: date Search parameter is on a date/time. The date format is the standard XML format, though other formats may be supported.

STRING

public static final RestSearchParameterTypeEnum STRING

Code Value: string Search parameter is a simple string, like a name part. Search is case-insensitive and accent-insensitive. May match just the start of a string. String parameters may contain spaces.

TOKEN

public static final RestSearchParameterTypeEnum TOKEN

Code Value: token Search parameter on a coded element or identifier. May be used to search through the text, displayname, code and code/codesystem (for codes) and label, system and key (for identifier). Its value is either a string or a pair of namespace and value, separated by a "|", depending on the modifier used.

REFERENCE

public static final RestSearchParameterTypeEnum REFERENCE

Code Value: reference A reference to another resource.

COMPOSITE

public static final RestSearchParameterTypeEnum COMPOSITE

Code Value: composite A composite search parameter that combines a search on two values together.

QUANTITY

public static final RestSearchParameterTypeEnum QUANTITY

Code Value: quantity A search parameter that searches on a quantity.

URI

public static final RestSearchParameterTypeEnum URI

Code Value: quantity A search parameter that searches on a quantity.

HAS

public static final RestSearchParameterTypeEnum HAS

_has parameter

Field Detail

VALUESET_IDENTIFIER

public static final String VALUESET_IDENTIFIER

Identifier for this Value Set: http://hl7.org/fhir/vs/search-param-type

See Also:

Constant Field Values

VALUESET_NAME

public static final String VALUESET_NAME

Name for this Value Set: SearchParamType

See Also:

Constant Field Values

VALUESET_BINDER

public static final IValueSetEnumBinder<RestSearchParameterTypeEnum> VALUESET_BINDER

Converts codes to their respective enumerated values

Method Detail

values

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

Returns:

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

valueOf

public static RestSearchParameterTypeEnum valueOf(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:

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

NullPointerException - if the argument is null

getCode

public String getCode()

Returns the code associated with this enumerated value

getSystem

public String getSystem()

Returns the code system associated with this enumerated value

forCode

public static RestSearchParameterTypeEnum forCode(String theCode)

Returns the enumerated value associated with this code