Package ca.uhn.fhir.rest.server.method

Class ResponseBundleRequest

java.lang.Object

ca.uhn.fhir.rest.server.method.ResponseBundleRequest

public class ResponseBundleRequest
extends Object

This is a request object for selecting resources from a bundle provider and returning a bundle to the client

Field Summary

Fields

Modifier and Type	Field	Description
final IBundleProvider	bundleProvider	The bundle provider that will be used as the source of resources for the returned bundle.
final ca.uhn.fhir.model.valueset.BundleTypeEnum	bundleType	The type of bundle that should be returned to the client.
final Set<ca.uhn.fhir.model.api.Include>	includes	The set of includes requested by the user.
final String	linkSelf	The response bundle link to self.
final int	offset	The requested offset into the list of resources that should be used to create the returned bundle.
final RequestDetails	requestDetails	The user request details.
final RequestedPage	requestedPage
final String	searchId	The id of the search used to page through search results
final IRestfulServer<?>	server	The FHIR REST server the request is coming from.

Constructor Summary

Constructors

Constructor	Description
ResponseBundleRequest(IRestfulServer<?> theServer, IBundleProvider theBundleProvider, RequestDetails theRequest, int theOffset, Integer theLimit, String theLinkSelf, Set<ca.uhn.fhir.model.api.Include> theIncludes, ca.uhn.fhir.model.valueset.BundleTypeEnum theBundleType, String theSearchId)

Method Summary

Modifier and Type	Method	Description
Map<String,String[]>	getRequestParameters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

server

public final IRestfulServer<?> server

The FHIR REST server the request is coming from. This is used to determine default page size.

bundleProvider

public final IBundleProvider bundleProvider

The bundle provider that will be used as the source of resources for the returned bundle.

requestDetails

public final RequestDetails requestDetails

The user request details. This is used to parse out parameters used to create the final bundle.

offset

public final int offset

The requested offset into the list of resources that should be used to create the returned bundle.

linkSelf

public final String linkSelf

The response bundle link to self. This is used to create "self" link in the returned bundle.

includes

public final Set<ca.uhn.fhir.model.api.Include> includes

The set of includes requested by the user. This is used to determine which resources should be additionally included in the returned bundle.

bundleType

public final ca.uhn.fhir.model.valueset.BundleTypeEnum bundleType

The type of bundle that should be returned to the client.

searchId

public final String searchId

The id of the search used to page through search results

requestedPage

public final RequestedPage requestedPage

Constructor Details

ResponseBundleRequest

public ResponseBundleRequest(IRestfulServer<?> theServer,
 IBundleProvider theBundleProvider,
 RequestDetails theRequest,
 int theOffset,
 Integer theLimit,
 String theLinkSelf,
 Set<ca.uhn.fhir.model.api.Include> theIncludes,
 ca.uhn.fhir.model.valueset.BundleTypeEnum theBundleType,
 String theSearchId)

Method Details

getRequestParameters

public Map<String,String[]> getRequestParameters()