ca.uhn.fhir.rest.param

Class TokenOrListParam

java.lang.Object

ca.uhn.fhir.rest.param.TokenOrListParam

All Implemented Interfaces:

IQueryParameterOr<TokenParam>, Serializable

public class TokenOrListParam
extends Object

This class represents a restful search operation parameter for an "OR list" of tokens (in other words, a list which can contain one-or-more tokens, where the server should return results matching any of the tokens)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TokenOrListParam() Create a new empty token "OR list"
TokenOrListParam(String theSystem, String... theValues) Create a new token "OR list" with a single token, or multiple tokens which have the same system value

Method Summary

Modifier and Type	Method and Description
void	add(BaseCodingDt theCodingDt) Convenience method which adds a token to this OR list using the system and code from a coding
void	add(BaseIdentifierDt theIdentifierDt) Convenience method which adds a token to this OR list using the system and value from an identifier
MT	add(PT theParameter)
void	add(String theSystem, String theValue) Add a new token to this list
TokenOrListParam	addOr(TokenParam theParameter)
boolean	doesCodingListMatch(List<? extends BaseCodingDt> theCodings)
List<BaseCodingDt>	getListAsCodings()
List<PT>	getValuesAsQueryTokens()
void	setValuesAsQueryTokens(FhirContext theContext, String theParamName, QualifiedParamList theParameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenOrListParam

public TokenOrListParam()

Create a new empty token "OR list"

TokenOrListParam

public TokenOrListParam(String theSystem,
                        String... theValues)

Create a new token "OR list" with a single token, or multiple tokens which have the same system value

Parameters:

theSystem - The system to use for the one token to pre-populate in this list

theValues - The values to use for the one token to pre-populate in this list

Method Detail

add

public void add(BaseCodingDt theCodingDt)

Convenience method which adds a token to this OR list using the system and code from a coding

add

public void add(BaseIdentifierDt theIdentifierDt)

Convenience method which adds a token to this OR list using the system and value from an identifier

add

public void add(String theSystem,
                String theValue)

Add a new token to this list

Parameters:

theSystem - The system to use for the one token to pre-populate in this list

theValue - The value to use for the one token to pre-populate in this list

getListAsCodings

public List<BaseCodingDt> getListAsCodings()

doesCodingListMatch

public boolean doesCodingListMatch(List<? extends BaseCodingDt> theCodings)

addOr

public TokenOrListParam addOr(TokenParam theParameter)

setValuesAsQueryTokens

public void setValuesAsQueryTokens(FhirContext theContext,
                                   String theParamName,
                                   QualifiedParamList theParameters)

Specified by:

setValuesAsQueryTokens in interface IQueryParameterOr<PT extends IQueryParameterType>

add

public MT add(PT theParameter)

getValuesAsQueryTokens

public List<PT> getValuesAsQueryTokens()

Specified by:

getValuesAsQueryTokens in interface IQueryParameterOr<PT extends IQueryParameterType>