ca.uhn.fhir.rest.server.method

Class TransactionParameter

java.lang.Object

ca.uhn.fhir.rest.server.method.TransactionParameter

All Implemented Interfaces:

IParameter

public class TransactionParameter
extends Object
implements IParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionParameter.ParamStyle

Constructor Summary

Constructors

Constructor and Description
TransactionParameter(ca.uhn.fhir.context.FhirContext theContext)

Method Summary

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

TransactionParameter

public TransactionParameter(ca.uhn.fhir.context.FhirContext theContext)

Method Detail

initializeTypes

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

Specified by:

initializeTypes in interface IParameter

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

getParamStyle

public TransactionParameter.ParamStyle getParamStyle()