ca.uhn.fhir.rest.client.method

Class OperationMethodBinding

java.lang.Object

ca.uhn.fhir.rest.client.method.BaseMethodBinding<Object>

ca.uhn.fhir.rest.client.method.BaseResourceReturningMethodBinding

ca.uhn.fhir.rest.client.method.OperationMethodBinding

All Implemented Interfaces:

IClientResponseHandler<Object>

Direct Known Subclasses:

ValidateMethodBindingDstu2Plus

public class OperationMethodBinding
extends BaseResourceReturningMethodBinding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperationMethodBinding.ReturnType

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

BaseResourceReturningMethodBinding.MethodReturnTypeEnum, BaseResourceReturningMethodBinding.ResourceOrDstu1Bundle, BaseResourceReturningMethodBinding.ReturnTypeEnum

Field Summary

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

ALLOWED_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OperationMethodBinding(Class<?> theReturnResourceType, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp, Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider, boolean theIdempotent, String theOperationName, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theOperationType, ca.uhn.fhir.rest.annotation.OperationParam[] theReturnParams, ca.uhn.fhir.model.valueset.BundleTypeEnum theBundleType)
	OperationMethodBinding(Class<?> theReturnResourceType, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp, Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider, ca.uhn.fhir.rest.annotation.Operation theAnnotation)

Method Summary

Modifier and Type	Method and Description
static BaseHttpClientInvocation	createOperationInvocation(ca.uhn.fhir.context.FhirContext theContext, String theResourceName, String theId, String theVersion, String theOperationName, org.hl7.fhir.instance.model.api.IBaseParameters theInput, boolean theUseHttpGet)
static BaseHttpClientInvocation	createProcessMsgInvocation(ca.uhn.fhir.context.FhirContext theContext, String theOperationName, org.hl7.fhir.instance.model.api.IBaseBundle theInput, Map<String,List<String>> urlParams)
String	getDescription()
String	getName() Returns the name of the operation, starting with "$"
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()
List<OperationMethodBinding.ReturnType>	getReturnParams()
BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
BaseHttpClientInvocation	invokeClient(Object[] theArgs)
boolean	isCanOperateAtInstanceLevel()
boolean	isCanOperateAtServerLevel()
boolean	isCanOperateAtTypeLevel()
boolean	isIdempotent()
void	setDescription(String theDescription)

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

getMethodReturnType, getResourceName, invokeClient, isAddContentLocationHeader, setResourceName

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

bindMethod, createAppropriateParserForParsingResponse, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, isResourceInterface, isSupportsConditional, isSupportsConditionalMultiple, processNon2xxResponseAndReturnExceptionToThrow, setParameters, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

OperationMethodBinding

protected OperationMethodBinding(Class<?> theReturnResourceType,
                                 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp,
                                 Method theMethod,
                                 ca.uhn.fhir.context.FhirContext theContext,
                                 Object theProvider,
                                 boolean theIdempotent,
                                 String theOperationName,
                                 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theOperationType,
                                 ca.uhn.fhir.rest.annotation.OperationParam[] theReturnParams,
                                 ca.uhn.fhir.model.valueset.BundleTypeEnum theBundleType)

OperationMethodBinding

public OperationMethodBinding(Class<?> theReturnResourceType,
                              Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp,
                              Method theMethod,
                              ca.uhn.fhir.context.FhirContext theContext,
                              Object theProvider,
                              ca.uhn.fhir.rest.annotation.Operation theAnnotation)

Method Detail

getDescription

public String getDescription()

getName

public String getName()

Returns the name of the operation, starting with "$"

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

getRestOperationType

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

Specified by:

getRestOperationType in class BaseMethodBinding<Object>

getReturnParams

public List<OperationMethodBinding.ReturnType> getReturnParams()

getReturnType

public BaseResourceReturningMethodBinding.ReturnTypeEnum getReturnType()

Specified by:

getReturnType in class BaseResourceReturningMethodBinding

invokeClient

public BaseHttpClientInvocation invokeClient(Object[] theArgs)
                                      throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException

Specified by:

invokeClient in class BaseMethodBinding<Object>

Throws:

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

isCanOperateAtInstanceLevel

public boolean isCanOperateAtInstanceLevel()

isCanOperateAtServerLevel

public boolean isCanOperateAtServerLevel()

isCanOperateAtTypeLevel

public boolean isCanOperateAtTypeLevel()

isIdempotent

public boolean isIdempotent()

setDescription

public void setDescription(String theDescription)

createOperationInvocation

public static BaseHttpClientInvocation createOperationInvocation(ca.uhn.fhir.context.FhirContext theContext,
                                                                 String theResourceName,
                                                                 String theId,
                                                                 String theVersion,
                                                                 String theOperationName,
                                                                 org.hl7.fhir.instance.model.api.IBaseParameters theInput,
                                                                 boolean theUseHttpGet)

createProcessMsgInvocation

public static BaseHttpClientInvocation createProcessMsgInvocation(ca.uhn.fhir.context.FhirContext theContext,
                                                                  String theOperationName,
                                                                  org.hl7.fhir.instance.model.api.IBaseBundle theInput,
                                                                  Map<String,List<String>> urlParams)