ca.uhn.fhir.rest.server

Interface IBundleProvider

All Known Implementing Classes:

SimpleBundleProvider

public interface IBundleProvider

Method Summary

Modifier and Type	Method and Description
IPrimitiveType<Date>	getPublished() Returns the instant as of which this result was valid
List<IBaseResource>	getResources(int theFromIndex, int theToIndex) Load the given collection of resources by index, plus any additional resources per the server's processing rules (e.g.
String	getUuid() Returns the UUID associated with this search.
Integer	preferredPageSize() Optionally may be used to signal a preferred page size to the server, e.g.
Integer	size() Returns the total number of results which match the given query (exclusive of any _include's or OperationOutcome).

Method Detail

getResources

List<IBaseResource> getResources(int theFromIndex,
                                 int theToIndex)

Load the given collection of resources by index, plus any additional resources per the server's processing rules (e.g. _include'd resources, OperationOutcome, etc.). For example, if the method is invoked with index 0,10 the method might return 10 search results, plus an additional 20 resources which matched a client's _include specification.

Parameters:

theFromIndex - The low index (inclusive) to return

theToIndex - The high index (exclusive) to return

Returns:

A list of resources. The size of this list must be at least theToIndex - theFromIndex.

preferredPageSize

Integer preferredPageSize()

Optionally may be used to signal a preferred page size to the server, e.g. because the implementing code recognizes that the resources which will be returned by this implementation are expensive to load so a smaller page size should be used. The value returned by this method will only be used if the client has not explicitly requested a page size.

Returns:

Returns the preferred page size or null

size

Integer size()

Returns the total number of results which match the given query (exclusive of any _include's or OperationOutcome). May return null if the total size is not known or would be too expensive to calculate.

getPublished

IPrimitiveType<Date> getPublished()

Returns the instant as of which this result was valid

getUuid

String getUuid()

Returns the UUID associated with this search. Note that this does not need to return a non-null value unless it a IPagingProvider is being used that requires UUIDs being returned.

In other words, if you are using the default FifoMemoryPagingProvider in your server, it is fine for this method to simply return null since FifoMemoryPagingProvider does not use the value anyhow. On the other hand, if you are creating a custom [@code IPagingProvider} implementation you might use this method to communicate the search ID back to the provider.