Package ca.uhn.fhir.rest.param
Class BaseParam
- java.lang.Object
-
- ca.uhn.fhir.rest.param.BaseParam
-
- All Implemented Interfaces:
IQueryParameterType,Serializable
- Direct Known Subclasses:
BaseParamWithPrefix,CompositeParam,HasParam,ReferenceParam,SpecialParam,StringParam,TokenParam,UriParam
public abstract class BaseParam extends Object implements IQueryParameterType
Base class for RESTful operation parameter types- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description BaseParam()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleangetMissing()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 valueStringgetQueryParameterQualifier()This method will return any qualifier that should be appended to the parameter name (e.g ":exact").StringgetValueAsQueryToken(FhirContext theContext)Returns a representation of this parameter's value as it will be represented "over the wire".protected booleanisSupportsChain()Does this parameter type support chained parameters (only reference should returntruefor this)BaseParamsetMissing(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 valuevoidsetValueAsQueryToken(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.
-
-
-
Constructor Detail
-
BaseParam
public BaseParam()
-
-
Method Detail
-
getMissing
public 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- Specified by:
getMissingin interfaceIQueryParameterType
-
getQueryParameterQualifier
public final String getQueryParameterQualifier()
Description copied from interface:IQueryParameterTypeThis method will return any qualifier that should be appended to the parameter name (e.g ":exact"). Returns null if none are present.- Specified by:
getQueryParameterQualifierin interfaceIQueryParameterType
-
getValueAsQueryToken
public final String getValueAsQueryToken(FhirContext theContext)
Description copied from interface:IQueryParameterTypeReturns 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
- Specified by:
getValueAsQueryTokenin interfaceIQueryParameterType- 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)
-
isSupportsChain
protected boolean isSupportsChain()
Does this parameter type support chained parameters (only reference should returntruefor this)
-
setMissing
public BaseParam 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- Specified by:
setMissingin interfaceIQueryParameterType- Returns:
- Returns a reference to
thisfor easier method chaining
-
setValueAsQueryToken
public final void setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theValue)
Description copied from interface:IQueryParameterTypeThis 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
- Specified by:
setValueAsQueryTokenin interfaceIQueryParameterType- Parameters:
theContext- TODOtheParamName- TODOtheQualifier- The parameter name qualifier that accompanied this value. For example, if the complete query washttp://foo?name:exact=John, qualifier would be ":exact"theValue- The actual parameter value. For example, if the complete query washttp://foo?name:exact=John, the value would be "John"
-
-