Package ca.uhn.fhir.rest.client.method

Class BaseQueryParameter

java.lang.Object

ca.uhn.fhir.rest.client.method.BaseQueryParameter

All Implemented Interfaces:

IParameter

Direct Known Subclasses:

SearchParameter

public abstract class BaseQueryParameter
extends Object
implements IParameter

Constructor Summary

Constructors

Constructor	Description
BaseQueryParameter()

Method Summary

Modifier and Type	Method	Description
abstract List<ca.uhn.fhir.rest.api.QualifiedParamList>	encode(ca.uhn.fhir.context.FhirContext theContext, Object theObject)
abstract String	getName()
abstract ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum	getParamType()
abstract boolean	handlesMissing()	Parameter should return true if parse(FhirContext, List) should be called even if the query string contained no values for the given parameter
void	initializeTypes(Method theMethod, Class<? extends Collection<?>> theOuterCollectionType, Class<? extends Collection<?>> theInnerCollectionType, Class<?> theParameterType)
abstract boolean	isRequired()
abstract Object	parse(ca.uhn.fhir.context.FhirContext theContext, List<ca.uhn.fhir.rest.api.QualifiedParamList> theString)
void	translateClientArgumentIntoQueryArgument(ca.uhn.fhir.context.FhirContext theContext, Object theSourceClientArgument, Map<String,List<String>> theTargetQueryArguments, org.hl7.fhir.instance.model.api.IBaseResource theTargetResource)

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseQueryParameter

public BaseQueryParameter()

Method Detail

encode

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

Throws:

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

getName

public abstract String getName()

getParamType

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

handlesMissing

public abstract boolean handlesMissing()

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

initializeTypes

public void initializeTypes(Method theMethod,
                            Class<? extends Collection<?>> theOuterCollectionType,
                            Class<? extends Collection<?>> theInnerCollectionType,
                            Class<?> theParameterType)

Specified by:

initializeTypes in interface IParameter

isRequired

public abstract boolean isRequired()

parse

public abstract 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

Throws:

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

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

translateClientArgumentIntoQueryArgument

public void translateClientArgumentIntoQueryArgument(ca.uhn.fhir.context.FhirContext theContext,
                                                     Object theSourceClientArgument,
                                                     Map<String,List<String>> theTargetQueryArguments,
                                                     org.hl7.fhir.instance.model.api.IBaseResource theTargetResource)
                                              throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException

Specified by:

translateClientArgumentIntoQueryArgument in interface IParameter

Throws:

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