ca.uhn.fhir.rest.gclient

Class ReferenceClientParam

java.lang.Object

ca.uhn.fhir.rest.gclient.ReferenceClientParam

All Implemented Interfaces:

IParam

public class ReferenceClientParam
extends Object
implements IParam

Constructor Summary

Constructors

Constructor and Description
ReferenceClientParam(String theName)

Method Summary

Modifier and Type	Method and Description
String	getParamName() Returns the name of this parameter
ICriterion<ReferenceClientParam>	hasAnyOfIds(Collection<String> theIds) Match the referenced resource if the resource has ANY of the given IDs (this is an OR search, not an AND search), (this can be the logical ID or the absolute URL of the resource).
ICriterion<ReferenceClientParam>	hasAnyOfIds(String... theIds) Match the referenced resource if the resource has ANY of the given IDs (this is an OR search, not an AND search), (this can be the logical ID or the absolute URL of the resource).
ICriterion<ReferenceClientParam>	hasChainedProperty(ICriterion<?> theCriterion) Include a chained search.
ICriterion<ReferenceClientParam>	hasChainedProperty(String theResourceType, ICriterion<?> theCriterion) Include a chained search with a resource type.
ICriterion<ReferenceClientParam>	hasId(IIdType theId) Match the referenced resource if the resource has the given ID (this can be the logical ID or the absolute URL of the resource)
ICriterion<ReferenceClientParam>	hasId(String theId) Match the referenced resource if the resource has the given ID (this can be the logical ID or the absolute URL of the resource)
ICriterion<?>	isMissing(boolean theMissing) Sets the :missing qualifier for this parameter.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.rest.gclient.IParam

isMissing

Constructor Detail

ReferenceClientParam

public ReferenceClientParam(String theName)

Method Detail

getParamName

public String getParamName()

Description copied from interface: IParam

Returns the name of this parameter

Specified by:

getParamName in interface IParam

hasChainedProperty

public ICriterion<ReferenceClientParam> hasChainedProperty(ICriterion<?> theCriterion)

Include a chained search. For example:

 Bundle resp = ourClient
   .search()
   .forResource(QuestionnaireResponse.class)
   .where(QuestionnaireResponse.SUBJECT.hasChainedProperty(Patient.FAMILY.matches().value("SMITH")))
   .returnBundle(Bundle.class)
   .execute();
 

hasChainedProperty

public ICriterion<ReferenceClientParam> hasChainedProperty(String theResourceType,
                                                           ICriterion<?> theCriterion)

Include a chained search with a resource type. For example:

 Bundle resp = ourClient
   .search()
   .forResource(QuestionnaireResponse.class)
   .where(QuestionnaireResponse.SUBJECT.hasChainedProperty("Patient", Patient.FAMILY.matches().value("SMITH")))
   .returnBundle(Bundle.class)
   .execute();
 

hasId

public ICriterion<ReferenceClientParam> hasId(IIdType theId)

Match the referenced resource if the resource has the given ID (this can be the logical ID or the absolute URL of the resource)

hasId

public ICriterion<ReferenceClientParam> hasId(String theId)

Match the referenced resource if the resource has the given ID (this can be the logical ID or the absolute URL of the resource)

hasAnyOfIds

public ICriterion<ReferenceClientParam> hasAnyOfIds(Collection<String> theIds)

Match the referenced resource if the resource has ANY of the given IDs (this is an OR search, not an AND search), (this can be the logical ID or the absolute URL of the resource). Note that to specify an AND search, simply add a subsequent where criteria with the same parameter.

hasAnyOfIds

public ICriterion<ReferenceClientParam> hasAnyOfIds(String... theIds)

Match the referenced resource if the resource has ANY of the given IDs (this is an OR search, not an AND search), (this can be the logical ID or the absolute URL of the resource). Note that to specify an AND search, simply add a subsequent where criteria with the same parameter.

isMissing

public ICriterion<?> isMissing(boolean theMissing)

Description copied from interface: IParam

Sets the :missing qualifier for this parameter. Set this to true to indicate that the server should return resources with this value

populated

. Set this to false to indicate that the server should return resources with this value missing.

Specified by:

isMissing in interface IParam