ReferenceParam (HAPI FHIR - Core Library 3.0.0 API)

java.lang.Object
- ca.uhn.fhir.rest.param.ReferenceParam

All Implemented Interfaces:

IQueryParameterType, Serializable
```
public class ReferenceParam
extends Object
```
See Also:

Serialized Form

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBaseUrl()`
`String`	`getChain()`
`String`	`getIdPart()`
`BigDecimal`	`getIdPartAsBigDecimal()`
`Long`	`getIdPartAsLong()`
`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`	`getResourceType()`
`Class<? extends IBaseResource>`	`getResourceType(FhirContext theCtx)`
`String`	`getValue()`
`String`	`getValueAsQueryToken(FhirContext theContext)` Returns a representation of this parameter's value as it will be represented "over the wire".
`boolean`	`hasResourceType()`
`protected boolean`	`isSupportsChain()` Does this parameter type support chained parameters (only reference should return `true` for this)
`ReferenceParam`	`setChain(String theChain)`
`ca.uhn.fhir.rest.param.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
`ReferenceParam`	`setValue(String theValue)`
`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.
`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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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
- Method Detail
  - getBaseUrl
```
public String getBaseUrl()
```
  - getChain
```
public String getChain()
```
  - 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()
```
  - hasResourceType
```
public boolean hasResourceType()
```
  - isSupportsChain
```
protected boolean isSupportsChain()
```
    Does this parameter type support chained parameters (only reference should return true for this)
  - setChain
```
public ReferenceParam setChain(String theChain)
```
  - setValue
```
public ReferenceParam setValue(String theValue)
```
  - 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.
  - 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:
    
    getMissing in interface IQueryParameterType
  - getQueryParameterQualifier
```
public final 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
  - getValueAsQueryToken
```
public final String getValueAsQueryToken(FhirContext theContext)
```
    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
    
    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)
  - setMissing
```
public ca.uhn.fhir.rest.param.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:
    
    setMissing in interface IQueryParameterType
    
    Returns:
    
    Returns a reference to this for easier method chaining
  - setValueAsQueryToken
```
public final void setValueAsQueryToken(FhirContext theContext,
                                       String theParamName,
                                       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:
    
    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"

Class ReferenceParam

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ReferenceParam

ReferenceParam

ReferenceParam

ReferenceParam

Method Detail

getBaseUrl

getChain

getIdPart

getIdPartAsBigDecimal

getIdPartAsLong

getResourceType

getResourceType

getValue

hasResourceType

isSupportsChain

setChain

setValue

toDateParam

toNumberParam

toQuantityParam

toString

toStringParam

toTokenParam

getMissing

getQueryParameterQualifier

getValueAsQueryToken

setMissing

setValueAsQueryToken