Class BaseQueryParameter

    • Method Detail

      • encode

        public abstract List<ca.uhn.fhir.rest.api.QualifiedParamList> encode​(ca.uhn.fhir.context.FhirContext theContext,
                                                                             Object theObject)
                                                                      throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException
        Throws:
        ca.uhn.fhir.rest.server.exceptions.InternalErrorException
      • getParamType

        public abstract ca.uhn.fhir.rest.api.RestSearchParameterTypeEnum getParamType()
      • 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
      • isRequired

        public abstract boolean isRequired()
      • parse

        public abstract Object parse​(ca.uhn.fhir.context.FhirContext theContext,
                                     List<ca.uhn.fhir.rest.api.QualifiedParamList> theString)
                              throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException,
                                     ca.uhn.fhir.rest.server.exceptions.InvalidRequestException
        Throws:
        ca.uhn.fhir.rest.server.exceptions.InternalErrorException
        ca.uhn.fhir.rest.server.exceptions.InvalidRequestException
      • 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