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

Class OperationParameter

java.lang.Object

ca.uhn.fhir.rest.server.method.OperationParameter

All Implemented Interfaces:

IParameter

public class OperationParameter
extends Object
implements IParameter

Method Summary

Modifier and Type	Method	Description
protected ca.uhn.fhir.context.FhirContext	getContext()
String	getDescription()
List<String>	getExampleValues()
int	getMax()
int	getMin()
String	getName()
String	getParamType()
String	getSearchParamType()
void	initializeTypes(Method theMethod, Class<? extends Collection<?>> theOuterCollectionType, Class<? extends Collection<?>> theInnerCollectionType, Class<?> theParameterType)
OperationParameter	setConverter(ca.uhn.fhir.rest.server.method.OperationParameter.IOperationParamConverter theConverter)
static void	throwInvalidMode(String paramValues)
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.
static void	validateTypeIsAppropriateVersionForContext(Method theMethod, Class<?> theParameterType, ca.uhn.fhir.context.FhirContext theContext, String theUseDescription)

Methods inherited from class java.lang.Object

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

Method Details

getContext

protected ca.uhn.fhir.context.FhirContext getContext()

getMax

public int getMax()

getMin

public int getMin()

getName

public String getName()

getParamType

public String getParamType()

getSearchParamType

public String getSearchParamType()

initializeTypes

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

Specified by:

initializeTypes in interface IParameter

validateTypeIsAppropriateVersionForContext

public static void validateTypeIsAppropriateVersionForContext(Method theMethod,
 Class<?> theParameterType,
 ca.uhn.fhir.context.FhirContext theContext,
 String theUseDescription)

setConverter

public OperationParameter setConverter(ca.uhn.fhir.rest.server.method.OperationParameter.IOperationParamConverter theConverter)

translateQueryParametersIntoServerArgument

public Object translateQueryParametersIntoServerArgument(RequestDetails theRequest,
 BaseMethodBinding<?> theMethodBinding)
                                                  throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException,
ca.uhn.fhir.rest.server.exceptions.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:

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

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

getDescription

public String getDescription()

getExampleValues

public List<String> getExampleValues()

throwInvalidMode

public static void throwInvalidMode(String paramValues)