ca.uhn.fhir.rest.gclient

Interface IOperationUntyped

public interface IOperationUntyped

Method Summary

Modifier and Type	Method and Description
<T extends IBaseParameters> IOperationUntypedWithInput<T>	withNoParameters(Class<T> theOutputParameterType) The operation does not require any input parameters
<T extends IBaseParameters> IOperationUntypedWithInputAndPartialOutput<T>	withParameter(Class<T> theParameterType, String theName, IBase theValue) Use chained method calls to construct a Parameters input.
<T extends IBaseParameters> IOperationUntypedWithInput<T>	withParameters(T theParameters) Use the given parameters resource as the input to the operation
<T extends IBaseParameters> IOperationUntypedWithInputAndPartialOutput<T>	withSearchParameter(Class<T> theParameterType, String theName, IQueryParameterType theValue) Use chained method calls to construct a Parameters input.

Method Detail

withParameters

<T extends IBaseParameters> IOperationUntypedWithInput<T> withParameters(T theParameters)

Use the given parameters resource as the input to the operation

Parameters:

theParameters - The parameters to use as input. May also be null if the operation does not require any input parameters.

withNoParameters

<T extends IBaseParameters> IOperationUntypedWithInput<T> withNoParameters(Class<T> theOutputParameterType)

The operation does not require any input parameters

Parameters:

theOutputParameterType - The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using)

withParameter

<T extends IBaseParameters> IOperationUntypedWithInputAndPartialOutput<T> withParameter(Class<T> theParameterType,
                                                                                        String theName,
                                                                                        IBase theValue)

Use chained method calls to construct a Parameters input. This form is a convenience in order to allow simple method chaining to be used to build up a parameters resource for the input of an operation without needing to manually construct one.

A sample invocation of this class could look like:

Bundle bundle = client.operation()
   .onInstance(new IdType("Patient/A161443"))
   .named("everything")
   .withParameter(Parameters.class, "_count", new IntegerType(50))
   .useHttpGet()
   .returnResourceType(Bundle.class)
   .execute();
 

Parameters:

theParameterType - The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using)

theName - The first parameter name

theValue - The first parameter value

withSearchParameter

<T extends IBaseParameters> IOperationUntypedWithInputAndPartialOutput<T> withSearchParameter(Class<T> theParameterType,
                                                                                              String theName,
                                                                                              IQueryParameterType theValue)

Use chained method calls to construct a Parameters input. This form is a convenience in order to allow simple method chaining to be used to build up a parameters resource for the input of an operation without needing to manually construct one.

Parameters:

theParameterType - The type to use for the output parameters (this should be set to Parameters.class drawn from the version of the FHIR structures you are using)

theName - The first parameter name

theValue - The first parameter value