Package ca.uhn.fhir.rest.param

Class TokenParam

java.lang.Object

ca.uhn.fhir.rest.param.BaseParam

ca.uhn.fhir.rest.param.TokenParam

All Implemented Interfaces:

IQueryParameterType, Serializable

public class TokenParam
extends BaseParam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
TokenParam()	Constructor
TokenParam(BaseCodingDt theCodingDt)	Constructor which copies the system and code from a InternalCodingDt instance and adds it as a parameter
TokenParam(BaseIdentifierDt theIdentifierDt)	Constructor which copies the system and value from a BaseIdentifierDt instance and adds it as a parameter
TokenParam(String theCode)	Constructor that takes a code but no system
TokenParam(String theSystem, String theValue)
TokenParam(String theSystem, String theValue, boolean theText)
TokenParam(IBaseCoding theCoding)	Construct a TokenParam from the IBaseCoding.getSystem() () system} and IBaseCoding.getCode() () code} of a IBaseCoding instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object theO)
TokenParamModifier	getModifier()	Returns the modifier for this token
String	getSystem()	Returns the system for this token.
String	getValue()	Returns the value for the token (generally the value to the right of the vertical bar on the URL)
InternalCodingDt	getValueAsCoding()
String	getValueNotNull()
int	hashCode()
boolean	isEmpty()	Returns true if this parameter has a null or empty BaseParam.getValueAsQueryToken() value, and doesn't have a BaseParam.getMissing() value.
boolean	isMdmExpand()
boolean	isText()	Returns true if getModifier() returns TokenParamModifier.TEXT
TokenParam	setMdmExpand(boolean theMdmExpand)
TokenParam	setModifier(TokenParamModifier theModifier)
TokenParam	setSystem(String theSystem)
TokenParam	setText(boolean theText)	Deprecated. Use setModifier(TokenParamModifier) instead
TokenParam	setValue(String theValue)
String	toString()

Methods inherited from class ca.uhn.fhir.rest.param.BaseParam

getMissing, getQueryParameterQualifier, getValueAsQueryToken, isSupportsChain, setMissing, setValueAsQueryToken

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.model.api.IQueryParameterType

getValueAsQueryToken

Constructor Details

TokenParam

public TokenParam()

Constructor

TokenParam

public TokenParam(BaseCodingDt theCodingDt)

Constructor which copies the system and code from a InternalCodingDt instance and adds it as a parameter

Parameters:

theCodingDt - The coding

TokenParam

public TokenParam(BaseIdentifierDt theIdentifierDt)

Constructor which copies the system and value from a BaseIdentifierDt instance and adds it as a parameter

Parameters:

theIdentifierDt - The identifier

TokenParam

public TokenParam(IBaseCoding theCoding)

Construct a TokenParam from the IBaseCoding.getSystem() () system} and IBaseCoding.getCode() () code} of a IBaseCoding instance.

Parameters:

theCoding - The coding

TokenParam

public TokenParam(String theSystem,
 String theValue)

TokenParam

public TokenParam(String theSystem,
 String theValue,
 boolean theText)

TokenParam

public TokenParam(String theCode)

Constructor that takes a code but no system

Method Details

isMdmExpand

public boolean isMdmExpand()

setMdmExpand

public TokenParam setMdmExpand(boolean theMdmExpand)

getModifier

public TokenParamModifier getModifier()

Returns the modifier for this token

setModifier

public TokenParam setModifier(TokenParamModifier theModifier)

getSystem

public String getSystem()

Returns the system for this token. Note that if a getModifier() is being used, the entire value of the parameter will be placed in value and this method will return null.

Also note that this value may be null or "" (empty string) and that each of these have a different meaning. When a token is passed on a URL and it has no vertical bar (often meaning "return values that match the given code in any codesystem") this method will return null. When a token is passed on a URL and it has a vetical bar but nothing before the bar (often meaning "return values that match the given code but that have no codesystem) this method will return ""

setSystem

public TokenParam setSystem(String theSystem)

getValue

public String getValue()

Returns the value for the token (generally the value to the right of the vertical bar on the URL)

setValue

public TokenParam setValue(String theValue)

getValueAsCoding

public InternalCodingDt getValueAsCoding()

getValueNotNull

public String getValueNotNull()

isEmpty

public boolean isEmpty()

Description copied from class: BaseParam

Returns true if this parameter has a null or empty BaseParam.getValueAsQueryToken() value, and doesn't have a BaseParam.getMissing() value.

Specified by:

isEmpty in interface IQueryParameterType

Overrides:

isEmpty in class BaseParam

isText

public boolean isText()

Returns true if getModifier() returns TokenParamModifier.TEXT

setText

@Deprecated
public TokenParam setText(boolean theText)

Deprecated.

Use setModifier(TokenParamModifier) instead

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object theO)

Overrides:

equals in class BaseParam

hashCode

public int hashCode()

Overrides:

hashCode in class BaseParam