ca.uhn.fhir.rest.method

Interface IParameter

All Known Implementing Classes:

BaseQueryParameter, CountParameter, DynamicSearchParameter, ElementsParameter, OperationParameter, ResourceParameter, SearchParameter, SortParameter, SummaryEnumParameter, TransactionParameter

public interface IParameter

Method Summary

Modifier and Type	Method and Description
void	initializeTypes(Method theMethod, Class<? extends Collection<?>> theOuterCollectionType, Class<? extends Collection<?>> theInnerCollectionType, Class<?> theParameterType)
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.

Method Detail

translateClientArgumentIntoQueryArgument

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

Throws:

InternalErrorException

translateQueryParametersIntoServerArgument

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

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.

Parameters:

theRequest - The incoming request object

theRequestContents - The parsed contents of the incoming request. E.g. if the request was an HTTP POST with a resource in the body, this argument would contain the parsed IResource instance.

theMethodBinding - TODO

Returns:

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

Throws:

InternalErrorException

InvalidRequestException

initializeTypes

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