ca.uhn.fhir.rest.gclient

Interface IQuery<T>

All Superinterfaces:

IBaseQuery<IQuery<T>>, IClientExecutable<IQuery<T>,T>

public interface IQuery<T>
extends IClientExecutable<IQuery<T>,T>, IBaseQuery<IQuery<T>>

Method Summary

Modifier and Type	Method and Description
IQuery<T>	and(ICriterion<?> theCriterion)
IQuery<T>	count(int theCount) Specifies the _count parameter, which indicates to the server how many resources should be returned on a single page.
IQuery<T>	include(Include theInclude) Add an "_include" specification or an "_include:recurse" specification.
IQuery<T>	lastUpdated(DateRangeParam theLastUpdated) Add a "_lastUpdated" specification
IQuery<T>	limitTo(int theLimitTo) Deprecated. This parameter is badly named, since FHIR calls this parameter "_count" and not "_limit". Use count(int) instead (it also sets the _count parameter)
<B extends IBaseBundle> IQuery<B>	returnBundle(Class<B> theClass) Request that the client return the specified bundle type, e.g.
IQuery<T>	revInclude(Include theIncludeTarget) Add a "_revinclude" specification
ISort<T>	sort()
IQuery<T>	usingStyle(SearchStyleEnum theStyle) Forces the query to perform the search using the given method (allowable methods are described in the FHIR Specification Section 2.1.11)
IQuery<T>	where(ICriterion<?> theCriterion)
IQuery<T>	withIdAndCompartment(String theResourceId, String theCompartmentName)
IQuery<T>	withProfile(String theProfileUri) Match only resources where the resource has the given profile declaration.
IQuery<T>	withSecurity(String theSystem, String theCode) Match only resources where the resource has the given security tag.
IQuery<T>	withTag(String theSystem, String theCode) Match only resources where the resource has the given tag.

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

andLogRequestAndResponse, elementsSubset, encodedJson, encodedXml, execute, prettyPrint, summaryMode

Method Detail

include

IQuery<T> include(Include theInclude)

Add an "_include" specification or an "_include:recurse" specification. If you are using a constant from one of the built-in structures you can select whether you want recursive behaviour by using the following syntax:

• Recurse: .include(Patient.INCLUDE_ORGANIZATION.asRecursive())
• No Recurse: .include(Patient.INCLUDE_ORGANIZATION.asNonRecursive())

sort

ISort<T> sort()

limitTo

@Deprecated
IQuery<T> limitTo(int theLimitTo)

Deprecated. This parameter is badly named, since FHIR calls this parameter "_count" and not "_limit". Use count(int) instead (it also sets the _count parameter)

Specifies the _count parameter, which indicates to the server how many resources should be returned on a single page.

count

IQuery<T> count(int theCount)

Specifies the _count parameter, which indicates to the server how many resources should be returned on a single page.

Since:

1.4

withTag

IQuery<T> withTag(String theSystem,
                  String theCode)

Match only resources where the resource has the given tag. This parameter corresponds to the _tag URL parameter.

Parameters:

theSystem - The tag code system, or null to match any code system (this may not be supported on all servers)

theCode - The tag code. Must not be null or empty.

withSecurity

IQuery<T> withSecurity(String theSystem,
                       String theCode)

Match only resources where the resource has the given security tag. This parameter corresponds to the _security URL parameter.

Parameters:

theSystem - The tag code system, or null to match any code system (this may not be supported on all servers)

theCode - The tag code. Must not be null or empty.

withProfile

IQuery<T> withProfile(String theProfileUri)

Match only resources where the resource has the given profile declaration. This parameter corresponds to the _profile URL parameter.

Parameters:

theSystem - The tag code system, or null to match any code system (this may not be supported on all servers)

theCode - The tag code. Must not be null or empty.

usingStyle

IQuery<T> usingStyle(SearchStyleEnum theStyle)

Forces the query to perform the search using the given method (allowable methods are described in the FHIR Specification Section 2.1.11)

Since:

0.6

See Also:

SearchStyleEnum

withIdAndCompartment

IQuery<T> withIdAndCompartment(String theResourceId,
                               String theCompartmentName)

revInclude

IQuery<T> revInclude(Include theIncludeTarget)

Add a "_revinclude" specification

Since:

HAPI FHIR 1.0 - Note that option was added to FHIR itself in DSTU2

lastUpdated

IQuery<T> lastUpdated(DateRangeParam theLastUpdated)

Add a "_lastUpdated" specification

Since:

HAPI FHIR 1.1 - Note that option was added to FHIR itself in DSTU2

returnBundle

<B extends IBaseBundle> IQuery<B> returnBundle(Class<B> theClass)

Request that the client return the specified bundle type, e.g. org.hl7.fhir.instance.model.Bundle.class or ca.uhn.fhir.model.dstu2.resource.Bundle.class

where

IQuery<T> where(ICriterion<?> theCriterion)

Specified by:

where in interface IBaseQuery<IQuery<T>>

and

IQuery<T> and(ICriterion<?> theCriterion)

Specified by:

and in interface IBaseQuery<IQuery<T>>