ca.uhn.fhir.rest.gclient

Interface IClientExecutable<T extends IClientExecutable<?,Y>,Y>

All Known Subinterfaces:

ICreateTyped, ICreateWithQueryTyped, IDeleteTyped, IDeleteWithQueryTyped, IFetchConformanceTyped<T>, IGetPageTyped<T>, IHistoryTyped<T>, IOperationProcessMsgMode<T>, IOperationUntypedWithInput<T>, IOperationUntypedWithInputAndPartialOutput<T>, IPatchExecutable, IPatchWithBody, IPatchWithQueryTyped, IQuery<Y>, IReadExecutable<T>, ITransactionTyped<T>, IUpdateExecutable, IUpdateTyped, IUpdateWithQueryTyped, IValidateUntyped

public interface IClientExecutable<T extends IClientExecutable<?,Y>,Y>

Method Summary

Modifier and Type	Method and Description
T	andLogRequestAndResponse(boolean theLogRequestAndResponse) Deprecated. Use the client logging interceptor to log requests and responses instead. See here for more information.
T	cacheControl(CacheControlDirective theCacheControlDirective) Sets the Cache-Control header value, which advises the server (or any cache in front of it) how to behave in terms of cached requests
T	elementsSubset(String... theElements) Request that the server return subsetted resources, containing only the elements specified in the given parameters.
T	encoded(EncodingEnum theEncoding)
T	encodedJson()
T	encodedXml()
Y	execute() Actually execute the client operation
T	preferResponseType(Class<? extends IBaseResource> theType) Explicitly specify a custom structure type to attempt to use when parsing the response.
T	preferResponseTypes(List<Class<? extends IBaseResource>> theTypes) Explicitly specify a list of custom structure types to attempt to use (in order from most to least preferred) when parsing the response.
T	prettyPrint()
T	summaryMode(SummaryEnum theSummary) Request that the server modify the response using the _summary param

Method Detail

andLogRequestAndResponse

@Deprecated
T andLogRequestAndResponse(boolean theLogRequestAndResponse)

Deprecated. Use the client logging interceptor to log requests and responses instead. See here for more information.

If set to true, the client will log the request and response to the SLF4J logger. This can be useful for debugging, but is generally not desirable in a production situation.

cacheControl

T cacheControl(CacheControlDirective theCacheControlDirective)

Sets the Cache-Control header value, which advises the server (or any cache in front of it) how to behave in terms of cached requests

elementsSubset

T elementsSubset(String... theElements)

Request that the server return subsetted resources, containing only the elements specified in the given parameters. For example: subsetElements("name", "identifier") requests that the server only return the "name" and "identifier" fields in the returned resource, and omit any others.

encoded

T encoded(EncodingEnum theEncoding)

encodedJson

T encodedJson()

encodedXml

T encodedXml()

execute

Y execute()

Actually execute the client operation

preferResponseType

T preferResponseType(Class<? extends IBaseResource> theType)

Explicitly specify a custom structure type to attempt to use when parsing the response. This is useful for invocations where the response is a Bundle/Parameters containing nested resources, and you want to use specific custom structures for those nested resources.

See Profiles and Extensions for more information on using custom structures

preferResponseTypes

T preferResponseTypes(List<Class<? extends IBaseResource>> theTypes)

Explicitly specify a list of custom structure types to attempt to use (in order from most to least preferred) when parsing the response. This is useful for invocations where the response is a Bundle/Parameters containing nested resources, and you want to use specific custom structures for those nested resources.

See Profiles and Extensions for more information on using custom structures

prettyPrint

T prettyPrint()

summaryMode

T summaryMode(SummaryEnum theSummary)

Request that the server modify the response using the _summary param