Package ca.uhn.fhir.rest.param

Class ReferenceParam

java.lang.Object

ca.uhn.fhir.rest.param.BaseParam

ca.uhn.fhir.rest.param.ReferenceParam

All Implemented Interfaces:

IQueryParameterType, Serializable

public class ReferenceParam
extends BaseParam

See Also:

• Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getBaseUrl()
String	getChain()
String	getIdPart()
BigDecimal	getIdPartAsBigDecimal()
Long	getIdPartAsLong()
String	getResourceType()
Class<? extends IBaseResource>	getResourceType(FhirContext theCtx)
String	getValue()
boolean	hasResourceType()
boolean	isIdPartValidLong()
boolean	isMdmExpand()
protected boolean	isSupportsChain()	Does this parameter type support chained parameters (only reference should return true for this)
ReferenceParam	setChain(String theChain)
ReferenceParam	setMdmExpand(boolean theMdmExpand)
ReferenceParam	setValue(String theValue)	Note that the parameter to this method must be a resource reference, e.g 123 or Patient/123 or http://example.com/fhir/Patient/123 or something like this.
DateParam	toDateParam(FhirContext theContext)	Returns a new param containing the same value as this param, but with the type copnverted to DateParam.
NumberParam	toNumberParam(FhirContext theContext)	Returns a new param containing the same value as this param, but with the type copnverted to NumberParam.
QuantityParam	toQuantityParam(FhirContext theContext)	Returns a new param containing the same value as this param, but with the type copnverted to QuantityParam.
String	toString()
StringParam	toStringParam(FhirContext theContext)	Returns a new param containing the same value as this param, but with the type copnverted to StringParam.
TokenParam	toTokenParam(FhirContext theContext)	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.rest.param.BaseParam

getMissing, getQueryParameterQualifier, getValueAsQueryToken, setMissing, setValueAsQueryToken

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

ReferenceParam

public ReferenceParam()

Constructor

ReferenceParam

public ReferenceParam(String theValue)

Constructor

ReferenceParam

public ReferenceParam(String theChain,
 String theValue)

Constructor

ReferenceParam

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

Constructor

ReferenceParam

public ReferenceParam(IIdType theValue)

Constructor

Since:

5.0.0

Method Details

getBaseUrl

public String getBaseUrl()

isMdmExpand

public boolean isMdmExpand()

setMdmExpand

public ReferenceParam setMdmExpand(boolean theMdmExpand)

getChain

public String getChain()

setChain

public ReferenceParam setChain(String theChain)

getIdPart

public String getIdPart()

getIdPartAsBigDecimal

public BigDecimal getIdPartAsBigDecimal()

getIdPartAsLong

public Long getIdPartAsLong()

getResourceType

public String getResourceType()

getResourceType

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

getValue

public String getValue()

setValue

public ReferenceParam setValue(String theValue)

Note that the parameter to this method must be a resource reference, e.g 123 or Patient/123 or http://example.com/fhir/Patient/123 or something like this. This is not appropriate for cases where a chain is being used and the value is for a different type of parameter (e.g. a token). In that case, use one of the setter constructors.

hasResourceType

public boolean hasResourceType()

isSupportsChain

protected boolean isSupportsChain()

Description copied from class: BaseParam

Does this parameter type support chained parameters (only reference should return true for this)

Overrides:

isSupportsChain in class BaseParam

toDateParam

public DateParam toDateParam(FhirContext theContext)

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(FhirContext theContext)

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(FhirContext theContext)

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 Object

toStringParam

public StringParam toStringParam(FhirContext theContext)

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(FhirContext theContext)

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.

isIdPartValidLong

public boolean isIdPartValidLong()