Package ca.uhn.fhir.rest.api

Enum SummaryEnum

java.lang.Object

java.lang.Enum<SummaryEnum>

ca.uhn.fhir.rest.api.SummaryEnum

All Implemented Interfaces:

Serializable, Comparable<SummaryEnum>

public enum SummaryEnum
extends Enum<SummaryEnum>

Enum representing the values for the _summary search parameter

Enum Constant Summary

Enum Constants

Enum Constant	Description
COUNT	Search only: just return a count of the matching resources, without returning the actual matches
DATA	Remove the text element
FALSE	Return all parts of the resource(s)
TEXT	Return only the 'text' element, and any mandatory elements
TRUE	Return only those elements marked as 'summary' in the base definition of the resource(s)

Method Summary

Modifier and Type	Method	Description
static SummaryEnum	fromCode(String theCode)
String	getCode()
static SummaryEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SummaryEnum[]	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

COUNT

public static final SummaryEnum COUNT

Search only: just return a count of the matching resources, without returning the actual matches

TEXT

public static final SummaryEnum TEXT

Return only the 'text' element, and any mandatory elements

DATA

public static final SummaryEnum DATA

Remove the text element

TRUE

public static final SummaryEnum TRUE

Return only those elements marked as 'summary' in the base definition of the resource(s)

FALSE

public static final SummaryEnum FALSE

Return all parts of the resource(s)

Method Detail

values

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

Returns:

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

valueOf

public static SummaryEnum 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()

fromCode

public static SummaryEnum fromCode(String theCode)