
Package ca.uhn.fhir.rest.server.method
Class OperationParameter
java.lang.Object
ca.uhn.fhir.rest.server.method.OperationParameter
- All Implemented Interfaces:
IParameter
-
Method Summary
Modifier and TypeMethodDescriptionprotected ca.uhn.fhir.context.FhirContext
int
getMax()
int
getMin()
getName()
void
initializeTypes
(Method theMethod, Class<? extends Collection<?>> theOuterCollectionType, Class<? extends Collection<?>> theInnerCollectionType, Class<?> theParameterType) setConverter
(ca.uhn.fhir.rest.server.method.OperationParameter.IOperationParamConverter theConverter) static void
throwInvalidMode
(String paramValues) 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)
-
Method Details
-
getContext
-
getMax
-
getMin
-
getName
-
getParamType
-
getSearchParamType
-
initializeTypes
public void initializeTypes(Method theMethod, Class<? extends Collection<?>> theOuterCollectionType, Class<? extends Collection<?>> theInnerCollectionType, Class<?> theParameterType) - Specified by:
initializeTypes
in interfaceIParameter
-
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 interfaceIParameter
- Parameters:
theRequest
- The incoming request objecttheMethodBinding
- 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
-
getExampleValues
-
throwInvalidMode
-