Package ca.uhn.fhir.model.api

Interface IQueryParameterType

All Superinterfaces:
Serializable
All Known Implementing Classes:
BaseCodingDt, BaseIdentifierDt, BaseParam, BaseParamWithPrefix, BaseQuantityDt, CompositeParam, DateParam, HasParam, InternalCodingDt, MarkdownDt, NumberParam, QuantityParam, ReferenceParam, SpecialParam, StringDt, StringParam, TimeDt, TokenParam, UriParam
public interface IQueryParameterType extends Serializable

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getMissing()
    If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value
    String
    getQueryParameterQualifier()
    This method will return any qualifier that should be appended to the parameter name (e.g ":exact").
    String
    getValueAsQueryToken(FhirContext theContext)
    Returns a representation of this parameter's value as it will be represented "over the wire".
    IQueryParameterType
    setMissing(Boolean theMissing)
    If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value
    void
    setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theValue)
    This method is generally only called by HAPI itself, and should not need to be called from user code.

  • Method Details

    • setValueAsQueryToken

      void setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theValue)
      This method is generally only called by HAPI itself, and should not need to be called from user code.

      See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

      Parameters:
      theContext - TODO
      theParamName - TODO
      theQualifier - The parameter name qualifier that accompanied this value. For example, if the complete query was http://foo?name:exact=John, qualifier would be ":exact"
      theValue - The actual parameter value. For example, if the complete query was http://foo?name:exact=John, the value would be "John"

    • getValueAsQueryToken

      String getValueAsQueryToken(FhirContext theContext)
      Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

      See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

      Parameters:
      theContext - TODO
      Returns:
      Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

    • getQueryParameterQualifier

      String getQueryParameterQualifier()
      This method will return any qualifier that should be appended to the parameter name (e.g ":exact"). Returns null if none are present.

    • getMissing

      Boolean getMissing()
      If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value

    • setMissing

      IQueryParameterType setMissing(Boolean theMissing)
      If set to non-null value, indicates that this parameter has been populated with a "[name]:missing=true" or "[name]:missing=false" vale instead of a normal value
      Returns:
      Returns a reference to this for easier method chaining