WorkerContext.NullClient (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.utils.WorkerContext.NullClient

All Implemented Interfaces:: IFHIRClient

Enclosing class:: WorkerContext

public class WorkerContext.NullClient
extends Object
implements IFHIRClient

Nested Class Summary
- Nested classes/interfaces inherited from interface org.hl7.fhir.instance.client.IFHIRClient
  IFHIRClient.VersionInfo

Constructor Summary

Constructors
Constructor and Description

NullClient()

Constructors
Constructor and Description
`NullClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Resource> OperationOutcome`	`create(Class<T> resourceClass, T resource)` Create a new resource with a server assigned id.
`<T extends Resource> boolean`	`delete(Class<T> resourceClass, String id)` Delete the resource with the given ID.
`ValueSet`	`expandValueset(ValueSet source)` invoke the expand operation and pass the value set for expansion
`Bundle`	`fetchFeed(String url)` Use this to follow a link found in a feed (e.g.
`String`	`getAddress()` for debugging- the server address that the client is using
`Conformance`	`getConformanceStatement()` Method returns a conformance statement for the system queried.
`Conformance`	`getConformanceStatement(boolean useOptionsVerb)` Method returns a conformance statement for the system queried.
`Conformance`	`getConformanceStatementQuick()` Method returns a conformance statement for the system queried.
`Conformance`	`getConformanceStatementQuick(boolean useOptionsVerb)` Method returns a conformance statement for the system queried.
`int`	`getMaximumRecordCount()` Returns the maximum record count specified for list operations such as search and history.
`String`	`getPreferredFeedFormat()` Returns the feed format in effect.
`String`	`getPreferredResourceFormat()` Returns the resource format in effect.
`IFHIRClient.VersionInfo`	`getVersions()` Get the Java verion of client and reference implementation, the client FHIR version, the server FHIR version, and the server software version.
`<T extends Resource> Bundle`	`history()` Retrieve the update history for all resource types since the start of server records.
`<T extends Resource> Bundle`	`history(Calendar lastUpdate)` Retrieve the update history for all resource types since the specified calendar date.
`<T extends Resource> Bundle`	`history(Calendar lastUpdate, Class<T> resourceClass)` Retrieve the update history for a resource type since the specified calendar date.
`<T extends Resource> Bundle`	`history(Calendar lastUpdate, Class<T> resourceClass, String id)` Retrieve the update history for a resource with given id since last update time.
`<T extends Resource> Bundle`	`history(Class<T> resourceClass)`
`<T extends Resource> Bundle`	`history(Class<T> resource, String id)` Retrieve the entire update history for a resource with the given id.
`<T extends Resource> Bundle`	`history(Date lastUpdate)`
`<T extends Resource> Bundle`	`history(Date lastUpdate, Class<T> resourceClass)`
`<T extends Resource> Bundle`	`history(Date lastUpdate, Class<T> resourceClass, String id)`
`IFHIRClient`	`initialize(String baseServiceUrl)` Call method to initialize FHIR client.
`void`	`initialize(String baseServiceUrl, int recordCount)` Call method to initialize FHIR client.
`<T extends Resource> Parameters`	`operateType(Class<T> resourceClass, String name, Parameters params)` Invoke an operation at the type level
`<T extends Resource> T`	`read(Class<T> resource, String id)` Read the current state of a resource.
`<T extends Resource> Bundle`	`search(Class<T> resourceClass, Map<String,String> params)` Return all results matching search query parameters for the given resource class.
`<T extends Resource> Bundle`	`searchPost(Class<T> resourceClass, T resource, Map<String,String> params)` Return all results matching search query parameters for the given resource class.
`void`	`setMaximumRecordCount(int recordCount)` Sets the maximum record count for list operations such as history and search.
`void`	`setPreferredFeedFormat(FeedFormat feedFormat)` Override the default feed format of 'application/atom+xml'.
`void`	`setPreferredResourceFormat(ResourceFormat resourceFormat)` Override the default resource format of 'application/fhir+xml'.
`Bundle`	`transaction(Bundle batch)` Update or create a set of resources
`<T extends Resource> T`	`update(Class<T> resourceClass, T resource, String id)` Update an existing resource by its id or create it if it is a new resource, not present on the server
`<T extends Resource> OperationOutcome`	`validate(Class<T> resourceClass, T resource, String id)` Validate resource payload.
`<T extends Resource> T`	`vread(Class<T> resource, String id, String versionid)` Read the state of a specific version of the resource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NullClient
```
public NullClient()
```
- Method Detail
  - getVersions
```
public IFHIRClient.VersionInfo getVersions()
```
    Description copied from interface: IFHIRClient
    
    Get the Java verion of client and reference implementation, the client FHIR version, the server FHIR version, and the server software version. The server information will be blank if no service URL is provided
    
    Specified by:
    
    getVersions in interface IFHIRClient
    
    Returns:
    
    the version information
  - initialize
```
public IFHIRClient initialize(String baseServiceUrl)
                       throws URISyntaxException
```
    Description copied from interface: IFHIRClient
    
    Call method to initialize FHIR client. This method must be invoked with a valid base server URL prior to using the client. Invalid base server URLs will result in a URISyntaxException being thrown.
    
    Specified by:
    
    initialize in interface IFHIRClient
    
    Parameters:
    
    baseServiceUrl - Base service URL for FHIR Service.
    
    Returns:
    
    Throws:
    
    URISyntaxException
  - initialize
```
public void initialize(String baseServiceUrl,
                       int recordCount)
                throws URISyntaxException
```
    Description copied from interface: IFHIRClient
    
    Call method to initialize FHIR client. This method must be invoked with a valid base server URL prior to using the client. Invalid base server URLs will result in a URISyntaxException being thrown.
    
    Specified by:
    
    initialize in interface IFHIRClient
    
    Parameters:
    
    baseServiceUrl - The base service URL
    
    Throws:
    
    URISyntaxException
  - setPreferredResourceFormat
```
public void setPreferredResourceFormat(ResourceFormat resourceFormat)
```
    Description copied from interface: IFHIRClient
    
    Override the default resource format of 'application/fhir+xml'. This format is used to set Accept and Content-Type headers for client requests.
    
    Specified by:
    
    setPreferredResourceFormat in interface IFHIRClient
  - getPreferredResourceFormat
```
public String getPreferredResourceFormat()
```
    Description copied from interface: IFHIRClient
    
    Returns the resource format in effect.
    
    Specified by:
    
    getPreferredResourceFormat in interface IFHIRClient
    
    Returns:
  - setPreferredFeedFormat
```
public void setPreferredFeedFormat(FeedFormat feedFormat)
```
    Description copied from interface: IFHIRClient
    
    Override the default feed format of 'application/atom+xml'. This format is used to set Accept and Content-Type headers for client requests.
    
    Specified by:
    
    setPreferredFeedFormat in interface IFHIRClient
  - getPreferredFeedFormat
```
public String getPreferredFeedFormat()
```
    Description copied from interface: IFHIRClient
    
    Returns the feed format in effect.
    
    Specified by:
    
    getPreferredFeedFormat in interface IFHIRClient
    
    Returns:
  - getMaximumRecordCount
```
public int getMaximumRecordCount()
```
    Description copied from interface: IFHIRClient
    
    Returns the maximum record count specified for list operations such as search and history.
    
    Specified by:
    
    getMaximumRecordCount in interface IFHIRClient
    
    Returns:
  - setMaximumRecordCount
```
public void setMaximumRecordCount(int recordCount)
```
    Description copied from interface: IFHIRClient
    
    Sets the maximum record count for list operations such as history and search.
    
    Specified by:
    
    setMaximumRecordCount in interface IFHIRClient
  - getConformanceStatement
```
public Conformance getConformanceStatement()
```
    Description copied from interface: IFHIRClient
    
    Method returns a conformance statement for the system queried.
    
    Specified by:
    
    getConformanceStatement in interface IFHIRClient
    
    Returns:
  - getConformanceStatement
```
public Conformance getConformanceStatement(boolean useOptionsVerb)
```
    Description copied from interface: IFHIRClient
    
    Method returns a conformance statement for the system queried.
    
    Specified by:
    
    getConformanceStatement in interface IFHIRClient
    
    Parameters:
    
    useOptionsVerb - If 'true', use OPTION rather than GET.
    
    Returns:
  - read
```
public <T extends Resource> T read(Class<T> resource,
                                   String id)
```
    Description copied from interface: IFHIRClient
    
    Read the current state of a resource.
    
    Specified by:
    
    read in interface IFHIRClient
    
    Returns:
  - vread
```
public <T extends Resource> T vread(Class<T> resource,
                                    String id,
                                    String versionid)
```
    Description copied from interface: IFHIRClient
    
    Read the state of a specific version of the resource
    
    Specified by:
    
    vread in interface IFHIRClient
    
    Returns:
  - update
```
public <T extends Resource> T update(Class<T> resourceClass,
                                     T resource,
                                     String id)
```
    Description copied from interface: IFHIRClient
    
    Update an existing resource by its id or create it if it is a new resource, not present on the server
    
    Specified by:
    
    update in interface IFHIRClient
    
    Returns:
  - delete
```
public <T extends Resource> boolean delete(Class<T> resourceClass,
                                           String id)
```
    Description copied from interface: IFHIRClient
    
    Delete the resource with the given ID.
    
    Specified by:
    
    delete in interface IFHIRClient
    
    Returns:
  - create
```
public <T extends Resource> OperationOutcome create(Class<T> resourceClass,
                                                    T resource)
```
    Description copied from interface: IFHIRClient
    
    Create a new resource with a server assigned id. Return the newly created resource with the id the server assigned.
    
    Specified by:
    
    create in interface IFHIRClient
    
    Returns:
  - history
```
public <T extends Resource> Bundle history(Calendar lastUpdate,
                                           Class<T> resourceClass,
                                           String id)
```
    Description copied from interface: IFHIRClient
    
    Retrieve the update history for a resource with given id since last update time. Last update may be null TODO - ensure this is the case.
    
    Specified by:
    
    history in interface IFHIRClient
    
    Returns:
  - history
```
public <T extends Resource> Bundle history(Date lastUpdate,
                                           Class<T> resourceClass,
                                           String id)
```
    Specified by:
    
    history in interface IFHIRClient
  - history
```
public <T extends Resource> Bundle history(Class<T> resource,
                                           String id)
```
    Description copied from interface: IFHIRClient
    
    Retrieve the entire update history for a resource with the given id. Last update may be null TODO - ensure this is the case.
    
    Specified by:
    
    history in interface IFHIRClient
    
    Returns:
  - history
```
public <T extends Resource> Bundle history(Calendar lastUpdate,
                                           Class<T> resourceClass)
```
    Description copied from interface: IFHIRClient
    
    Retrieve the update history for a resource type since the specified calendar date. Last update may be null TODO - ensure this is the case.
    
    Specified by:
    
    history in interface IFHIRClient
    
    Returns:
  - history
```
public <T extends Resource> Bundle history(Date lastUpdate,
                                           Class<T> resourceClass)
```
    Specified by:
    
    history in interface IFHIRClient
  - history
```
public <T extends Resource> Bundle history(Class<T> resourceClass)
```
    Specified by:
    
    history in interface IFHIRClient
  - history
```
public <T extends Resource> Bundle history(Calendar lastUpdate)
```
    Description copied from interface: IFHIRClient
    
    Retrieve the update history for all resource types since the specified calendar date. Last update may be null Note:
    
    Specified by:
    
    history in interface IFHIRClient
    
    Returns:
  - history
```
public <T extends Resource> Bundle history(Date lastUpdate)
```
    Specified by:
    
    history in interface IFHIRClient
  - history
```
public <T extends Resource> Bundle history()
```
    Description copied from interface: IFHIRClient
    
    Retrieve the update history for all resource types since the start of server records. Note:
    
    Specified by:
    
    history in interface IFHIRClient
    
    Returns:
  - validate
```
public <T extends Resource> OperationOutcome validate(Class<T> resourceClass,
                                                      T resource,
                                                      String id)
```
    Description copied from interface: IFHIRClient
    
    Validate resource payload.
    
    Specified by:
    
    validate in interface IFHIRClient
    
    Returns:
  - search
```
public <T extends Resource> Bundle search(Class<T> resourceClass,
                                          Map<String,String> params)
```
    Description copied from interface: IFHIRClient
    
    Return all results matching search query parameters for the given resource class.
    
    Specified by:
    
    search in interface IFHIRClient
    
    Returns:
  - searchPost
```
public <T extends Resource> Bundle searchPost(Class<T> resourceClass,
                                              T resource,
                                              Map<String,String> params)
```
    Description copied from interface: IFHIRClient
    
    Return all results matching search query parameters for the given resource class. This includes a resource as one of the parameters, and performs a post
    
    Specified by:
    
    searchPost in interface IFHIRClient
    
    Returns:
  - transaction
```
public Bundle transaction(Bundle batch)
```
    Description copied from interface: IFHIRClient
    
    Update or create a set of resources
    
    Specified by:
    
    transaction in interface IFHIRClient
    
    Returns:
  - fetchFeed
```
public Bundle fetchFeed(String url)
```
    Description copied from interface: IFHIRClient
    
    Use this to follow a link found in a feed (e.g. paging in a search)
    
    Specified by:
    
    fetchFeed in interface IFHIRClient
    
    Returns:
    
    the feed the server returns
  - expandValueset
```
public ValueSet expandValueset(ValueSet source)
                        throws Exception
```
    Description copied from interface: IFHIRClient
    
    invoke the expand operation and pass the value set for expansion
    
    Specified by:
    
    expandValueset in interface IFHIRClient
    
    Returns:
    
    Throws:
    
    Exception
  - operateType
```
public <T extends Resource> Parameters operateType(Class<T> resourceClass,
                                                   String name,
                                                   Parameters params)
```
    Description copied from interface: IFHIRClient
    
    Invoke an operation at the type level
    
    Specified by:
    
    operateType in interface IFHIRClient
    
    Parameters:
    
    resourceClass - - the type on which to perform the operation
    
    name - - the name of the operation to invoke
    
    params - - parameters to pass to the operation. If the parameters are all simple, a GET will be performed
    
    Returns:
  - getConformanceStatementQuick
```
public Conformance getConformanceStatementQuick()
```
    Description copied from interface: IFHIRClient
    
    Method returns a conformance statement for the system queried.
    
    Specified by:
    
    getConformanceStatementQuick in interface IFHIRClient
    
    Returns:
  - getConformanceStatementQuick
```
public Conformance getConformanceStatementQuick(boolean useOptionsVerb)
```
    Description copied from interface: IFHIRClient
    
    Method returns a conformance statement for the system queried.
    
    Specified by:
    
    getConformanceStatementQuick in interface IFHIRClient
    
    Parameters:
    
    useOptionsVerb - If 'true', use OPTION rather than GET.
    
    Returns:
  - getAddress
```
public String getAddress()
```
    Description copied from interface: IFHIRClient
    
    for debugging- the server address that the client is using
    
    Specified by:
    
    getAddress in interface IFHIRClient
    
    Returns:

Class WorkerContext.NullClient

Nested Class Summary

Nested classes/interfaces inherited from interface org.hl7.fhir.instance.client.IFHIRClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NullClient

Method Detail

getVersions

initialize

initialize

setPreferredResourceFormat

getPreferredResourceFormat

setPreferredFeedFormat

getPreferredFeedFormat

getMaximumRecordCount

setMaximumRecordCount

getConformanceStatement

getConformanceStatement

read

vread

update

delete

create

history

history

history

history

history

history

history

history

history

validate

search

searchPost

transaction

fetchFeed

expandValueset

operateType

getConformanceStatementQuick

getConformanceStatementQuick

getAddress