ca.uhn.fhir.rest.param

Class BaseQueryParameter

java.lang.Object

ca.uhn.fhir.rest.param.BaseQueryParameter

All Implemented Interfaces:

IParameter

Direct Known Subclasses:

SearchParameter

public abstract class BaseQueryParameter
extends Object
implements IParameter

Constructor Summary

Constructors

Constructor and Description
BaseQueryParameter()

Method Summary

Modifier and Type	Method and Description
abstract List<QualifiedParamList>	encode(FhirContext theContext, Object theObject)
abstract String	getName()
abstract RestSearchParameterTypeEnum	getParamType()
Set<String>	getQualifierBlacklist() Returns null if blacklist is "none"
Set<String>	getQualifierWhitelist() Returns null if whitelist is "all"
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(FhirContext theContext, List<QualifiedParamList> theString)
void	translateClientArgumentIntoQueryArgument(FhirContext theContext, Object theSourceClientArgument, Map<String,List<String>> theTargetQueryArguments, IBaseResource theTargetResource)
Object	translateQueryParametersIntoServerArgument(RequestDetails theRequest, BaseMethodBinding<?> theMethodBinding) This server method method takes the data received by the server in an incoming request, and translates that data into a single argument for a server method invocation.

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<QualifiedParamList> encode(FhirContext theContext,
                                                Object theObject)
                                         throws InternalErrorException

Throws:

InternalErrorException

getName

public abstract String getName()

getParamType

public abstract RestSearchParameterTypeEnum getParamType()

getQualifierBlacklist

public Set<String> getQualifierBlacklist()

Returns null if blacklist is "none"

getQualifierWhitelist

public Set<String> getQualifierWhitelist()

Returns null if whitelist is "all"

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(FhirContext theContext,
                             List<QualifiedParamList> theString)
                      throws InternalErrorException,
                             InvalidRequestException

Throws:

InternalErrorException

InvalidRequestException

translateClientArgumentIntoQueryArgument

public void translateClientArgumentIntoQueryArgument(FhirContext theContext,
                                                     Object theSourceClientArgument,
                                                     Map<String,List<String>> theTargetQueryArguments,
                                                     IBaseResource theTargetResource)
                                              throws InternalErrorException

Specified by:

translateClientArgumentIntoQueryArgument in interface IParameter

Throws:

InternalErrorException

translateQueryParametersIntoServerArgument

public Object translateQueryParametersIntoServerArgument(RequestDetails theRequest,
                                                         BaseMethodBinding<?> theMethodBinding)
                                                  throws InternalErrorException,
                                                         InvalidRequestException

Description copied from interface: IParameter

This server method method takes the data received by the server in an incoming request, and translates that data into a single argument for a server method invocation. Note that all received data is passed to this method, but the expectation is that not necessarily that all data is used by every parameter.

Specified by:

translateQueryParametersIntoServerArgument in interface IParameter

Parameters:

theRequest - The incoming request object

theMethodBinding - TODO

Returns:

Returns the argument object as it will be passed to the IResourceProvider method.

Throws:

InternalErrorException

InvalidRequestException