Package ca.uhn.fhir.rest.server.method

Class SearchParameter

java.lang.Object

ca.uhn.fhir.rest.server.method.BaseQueryParameter

ca.uhn.fhir.rest.server.method.SearchParameter

All Implemented Interfaces:

IParameter

public class SearchParameter
extends BaseQueryParameter

Constructor Summary

Constructors

Constructor	Description
SearchParameter()
SearchParameter(String theName, boolean theRequired)

Method Summary

Modifier and Type	Method	Description
List<ca.uhn.fhir.rest.api.QualifiedParamList>	encode(ca.uhn.fhir.context.FhirContext theContext, Object theObject)
List<Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>>	getDeclaredTypes()
String	getDescription()
String	getName()
ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum	getParamType()
Set<String>	getQualifierBlacklist()	Returns null if blacklist is "none"
Set<String>	getQualifierWhitelist()	Returns null if whitelist is "all"
Class<?>	getType()
boolean	handlesMissing()	Parameter should return true if BaseQueryParameter.parse(FhirContext, List) should be called even if the query string contained no values for the given parameter
boolean	isRequired()
Object	parse(ca.uhn.fhir.context.FhirContext theContext, List<ca.uhn.fhir.rest.api.QualifiedParamList> theString)
void	setChainlists(String[] theChainWhitelist, String[] theChainBlacklist)
void	setCompositeTypes(Class<? extends ca.uhn.fhir.model.api.IQueryParameterType>[] theCompositeTypes)
void	setDeclaredTypes(Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>[] theTypes)
void	setDescription(String theDescription)
void	setName(String name)
void	setRequired(boolean required)
void	setType(ca.uhn.fhir.context.FhirContext theContext, Class<?> type, Class<? extends Collection<?>> theInnerCollectionType, Class<? extends Collection<?>> theOuterCollectionType)
String	toString()

Methods inherited from class ca.uhn.fhir.rest.server.method.BaseQueryParameter

initializeTypes, translateQueryParametersIntoServerArgument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchParameter

public SearchParameter()

SearchParameter

public SearchParameter(String theName,
                       boolean theRequired)

Method Detail

encode

public List<ca.uhn.fhir.rest.api.QualifiedParamList> encode(ca.uhn.fhir.context.FhirContext theContext,
                                                            Object theObject)
                                                     throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException

Specified by:

encode in class BaseQueryParameter

Throws:

ca.uhn.fhir.rest.server.exceptions.InternalErrorException

getDeclaredTypes

public List<Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>> getDeclaredTypes()

getDescription

public String getDescription()

getName

public String getName()

Specified by:

getName in class BaseQueryParameter

getParamType

public ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum getParamType()

Specified by:

getParamType in class BaseQueryParameter

getQualifierBlacklist

public Set<String> getQualifierBlacklist()

Description copied from class: BaseQueryParameter

Returns null if blacklist is "none"

Overrides:

getQualifierBlacklist in class BaseQueryParameter

getQualifierWhitelist

public Set<String> getQualifierWhitelist()

Description copied from class: BaseQueryParameter

Returns null if whitelist is "all"

Overrides:

getQualifierWhitelist in class BaseQueryParameter

getType

public Class<?> getType()

handlesMissing

public boolean handlesMissing()

Description copied from class: BaseQueryParameter

Parameter should return true if BaseQueryParameter.parse(FhirContext, List) should be called even if the query string contained no values for the given parameter

Specified by:

handlesMissing in class BaseQueryParameter

isRequired

public boolean isRequired()

Specified by:

isRequired in class BaseQueryParameter

parse

public Object parse(ca.uhn.fhir.context.FhirContext theContext,
                    List<ca.uhn.fhir.rest.api.QualifiedParamList> theString)
             throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException,
                    ca.uhn.fhir.rest.server.exceptions.InvalidRequestException

Specified by:

parse in class BaseQueryParameter

Throws:

ca.uhn.fhir.rest.server.exceptions.InternalErrorException

ca.uhn.fhir.rest.server.exceptions.InvalidRequestException

setChainlists

public void setChainlists(String[] theChainWhitelist,
                          String[] theChainBlacklist)

setCompositeTypes

public void setCompositeTypes(Class<? extends ca.uhn.fhir.model.api.IQueryParameterType>[] theCompositeTypes)

setDeclaredTypes

public void setDeclaredTypes(Class<? extends org.hl7.fhir.instance.model.api.IBaseResource>[] theTypes)

setDescription

public void setDescription(String theDescription)

setName

public void setName(String name)

setRequired

public void setRequired(boolean required)

setType

public void setType(ca.uhn.fhir.context.FhirContext theContext,
                    Class<?> type,
                    Class<? extends Collection<?>> theInnerCollectionType,
                    Class<? extends Collection<?>> theOuterCollectionType)

toString

public String toString()

Overrides:

toString in class Object