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

Class SearchMethodBinding

java.lang.Object

ca.uhn.fhir.rest.server.method.BaseMethodBinding

ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

ca.uhn.fhir.rest.server.method.SearchMethodBinding

public class SearchMethodBinding
extends BaseResourceReturningMethodBinding

Nested Class Summary

Nested classes/interfaces inherited from class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

BaseResourceReturningMethodBinding.MethodReturnTypeEnum, BaseResourceReturningMethodBinding.ReturnTypeEnum

Field Summary

Fields inherited from class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

myResponseBundleBuilder

Constructor Summary

Constructors

Constructor	Description
SearchMethodBinding(Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnResourceType, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theResourceProviderResourceType, Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider)

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getQueryName()
String	getResourceProviderResourceName()
protected ca.uhn.fhir.model.valueset.BundleTypeEnum	getResponseBundleType()	If the response is a bundle, this type will be placed in the root of the bundle (can be null)
ca.uhn.fhir.rest.api.RestOperationTypeEnum	getRestOperationType()
BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
MethodMatchEnum	incomingServerRequestMatchesMethod(RequestDetails theRequest)
IBundleProvider	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest, Object[] theMethodParams)
protected boolean	isAddContentLocationHeader()	Should the response include a Content-Location header.
static boolean	isPlainSearchRequest(RequestDetails theRequest)	Is this request a request for a normal search - Ie.
String	toString()

Methods inherited from class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

callOutgoingFailureOperationOutcomeHook, callOutgoingResponseHook, doInvokeServer, getMethodReturnType, getResourceName, invokeServer, isOffsetModeHistory, provideExpectedReturnTypes, setResourceName

Methods inherited from class ca.uhn.fhir.rest.server.method.BaseMethodBinding

bindMethod, close, createMethodParams, createParametersForServerRequest, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getQueryParameters, getRequestIncludesFromParams, getRestOperationType, getRevIncludes, invokeServerMethod, isGlobalMethod, isSupportsConditional, isSupportsConditionalMultiple, populateRequestDetailsForInterceptor, setParameters, toResourceList, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Details

SearchMethodBinding

public SearchMethodBinding(Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnResourceType,
 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theResourceProviderResourceType,
 Method theMethod,
 ca.uhn.fhir.context.FhirContext theContext,
 Object theProvider)

Method Details

getDescription

public String getDescription()

getQueryName

public String getQueryName()

getResourceProviderResourceName

public String getResourceProviderResourceName()

getRestOperationType

@Nonnull
public ca.uhn.fhir.rest.api.RestOperationTypeEnum getRestOperationType()

Specified by:

getRestOperationType in class BaseMethodBinding

getResponseBundleType

protected ca.uhn.fhir.model.valueset.BundleTypeEnum getResponseBundleType()

Description copied from class: BaseResourceReturningMethodBinding

If the response is a bundle, this type will be placed in the root of the bundle (can be null)

Specified by:

getResponseBundleType in class BaseResourceReturningMethodBinding

getReturnType

public BaseResourceReturningMethodBinding.ReturnTypeEnum getReturnType()

Specified by:

getReturnType in class BaseResourceReturningMethodBinding

incomingServerRequestMatchesMethod

public MethodMatchEnum incomingServerRequestMatchesMethod(RequestDetails theRequest)

Specified by:

incomingServerRequestMatchesMethod in class BaseMethodBinding

isPlainSearchRequest

public static boolean isPlainSearchRequest(RequestDetails theRequest)

Is this request a request for a normal search - Ie. not a named search, nor a compartment search, just a plain old search.

Since:

5.4.0

invokeServer

public IBundleProvider invokeServer(IRestfulServer<?> theServer,
 RequestDetails theRequest,
 Object[] theMethodParams)
                             throws ca.uhn.fhir.rest.server.exceptions.InvalidRequestException,
ca.uhn.fhir.rest.server.exceptions.InternalErrorException

Specified by:

invokeServer in class BaseResourceReturningMethodBinding

Throws:

ca.uhn.fhir.rest.server.exceptions.InvalidRequestException

ca.uhn.fhir.rest.server.exceptions.InternalErrorException

isAddContentLocationHeader

protected boolean isAddContentLocationHeader()

Description copied from class: BaseResourceReturningMethodBinding

Should the response include a Content-Location header. Search method bunding (and any others?) may override this to disable the content-location, since it doesn't make sense

Overrides:

isAddContentLocationHeader in class BaseResourceReturningMethodBinding

toString

public String toString()

Overrides:

toString in class Object