ca.uhn.fhir.rest.param

Class ReferenceParam

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.api.BasePrimitive<String>

ca.uhn.fhir.model.primitive.UriDt

ca.uhn.fhir.model.primitive.IdDt

ca.uhn.fhir.rest.param.ReferenceParam

All Implemented Interfaces:

IDatatype, IElement, IIdentifiableElement, IPrimitiveDatatype<String>, IQueryParameterType, ISupportsUndeclaredExtensions, Externalizable, Serializable, IBase, IBaseDatatype, IIdType, IPrimitiveType<String>

public class ReferenceParam
extends IdDt
implements IQueryParameterType

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReferenceParam()
ReferenceParam(String theValue)
ReferenceParam(String theChain, String theValue)
ReferenceParam(String theResourceType, String theChain, String theValue)

Method Summary

Modifier and Type	Method and Description
String	getChain()
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")
Class<? extends IBaseResource>	getResourceType(FhirContext theCtx)
String	getValueAsQueryToken() Returns a representation of this parameter's value as it will be represented "over the wire".
void	setChain(String theChain)
void	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(String theQualifier, String theValue) This method is generally only called by HAPI itself, and should not need to be called from user code.
DateParam	toDateParam() Returns a new param containing the same value as this param, but with the type copnverted to DateParam.
NumberParam	toNumberParam() Returns a new param containing the same value as this param, but with the type copnverted to NumberParam.
QuantityParam	toQuantityParam() Returns a new param containing the same value as this param, but with the type copnverted to QuantityParam.
String	toString()
StringParam	toStringParam() Returns a new param containing the same value as this param, but with the type copnverted to StringParam.
TokenParam	toTokenParam() Returns a new param containing the same value as this param, but with the type copnverted to TokenParam.

Methods inherited from class ca.uhn.fhir.model.primitive.IdDt

applyTo, asBigDecimal, equals, equalsIgnoreBase, getBaseUrl, getIdPart, getIdPartAsBigDecimal, getIdPartAsLong, getResourceType, getValue, getValueAsString, getVersionIdPart, getVersionIdPartAsLong, hasBaseUrl, hashCode, hasIdPart, hasResourceType, hasVersionIdPart, isAbsolute, isEmpty, isIdPartValid, isIdPartValidLong, isLocal, isVersionIdPartValidLong, newRandomUuid, of, setId, setParts, setValue, setValueAsString, toUnqualified, toUnqualifiedVersionless, toVersionless, withResourceType, withServerBase, withVersion

Methods inherited from class ca.uhn.fhir.model.primitive.UriDt

encode, equals, fromOid, parse

Methods inherited from class ca.uhn.fhir.model.api.BasePrimitive

readExternal, updateStringValue, writeExternal

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReferenceParam

public ReferenceParam()

ReferenceParam

public ReferenceParam(String theValue)

ReferenceParam

public ReferenceParam(String theChain,
                      String theValue)

ReferenceParam

public ReferenceParam(String theResourceType,
                      String theChain,
                      String theValue)

Method Detail

getChain

public String getChain()

getMissing

public Boolean getMissing()

Description copied from interface: IQueryParameterType

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:

getMissing in interface IQueryParameterType

getQueryParameterQualifier

public String getQueryParameterQualifier()

Description copied from interface: IQueryParameterType

This method will return any qualifier that should be appended to the parameter name (e.g ":exact")

Specified by:

getQueryParameterQualifier in interface IQueryParameterType

getResourceType

public Class<? extends IBaseResource> getResourceType(FhirContext theCtx)

getValueAsQueryToken

public String getValueAsQueryToken()

Description copied from interface: IQueryParameterType

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

Specified by:

getValueAsQueryToken in interface IQueryParameterType

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)

setChain

public void setChain(String theChain)

setMissing

public void setMissing(Boolean theMissing)

Description copied from interface: IQueryParameterType

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:

setMissing in interface IQueryParameterType

setValueAsQueryToken

public void setValueAsQueryToken(String theQualifier,
                                 String theValue)

Description copied from interface: IQueryParameterType

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

Specified by:

setValueAsQueryToken in interface IQueryParameterType

Parameters:

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"

toDateParam

public DateParam toDateParam()

Returns a new param containing the same value as this param, but with the type copnverted to DateParam. This is useful if you are using reference parameters and want to handle chained parameters of different types in a single method.

See Dynamic Chains in the HAPI FHIR documentation for an example of how to use this method.

toNumberParam

public NumberParam toNumberParam()

Returns a new param containing the same value as this param, but with the type copnverted to NumberParam. This is useful if you are using reference parameters and want to handle chained parameters of different types in a single method.

See Dynamic Chains in the HAPI FHIR documentation for an example of how to use this method.

toQuantityParam

public QuantityParam toQuantityParam()

Returns a new param containing the same value as this param, but with the type copnverted to QuantityParam. This is useful if you are using reference parameters and want to handle chained parameters of different types in a single method.

See Dynamic Chains in the HAPI FHIR documentation for an example of how to use this method.

toString

public String toString()

Overrides:

toString in class IdDt

toStringParam

public StringParam toStringParam()

Returns a new param containing the same value as this param, but with the type copnverted to StringParam. This is useful if you are using reference parameters and want to handle chained parameters of different types in a single method.

See Dynamic Chains in the HAPI FHIR documentation for an example of how to use this method.

toTokenParam

public TokenParam toTokenParam()

Returns a new param containing the same value as this param, but with the type copnverted to TokenParam. This is useful if you are using reference parameters and want to handle chained parameters of different types in a single method.

See Dynamic Chains in the HAPI FHIR documentation for an example of how to use this method.