ca.uhn.fhir.rest.server

Interface IBundleProvider

All Known Implementing Classes:

SimpleBundleProvider

public interface IBundleProvider

Method Summary

Modifier and Type	Method and Description
InstantDt	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.
Integer	preferredPageSize() Optionally may be used to signal a preferred page size to the server, e.g.
int	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

int size()

Returns the total number of results which match the given query (exclusive of any _include's or OperationOutcome)

getPublished

InstantDt getPublished()

Returns the instant as of which this result was valid