Package ca.uhn.fhir.rest.annotation

Annotation Interface ConditionalUrlParam

@Retention(RUNTIME) @Target(PARAMETER) public @interface ConditionalUrlParam
On the Update, Create and Delete operation methods, this annotation can be used to mark a String parameter which will be populated with the conditional "search" URL for the operation, if an incoming client invocation is a conditional operation. For non-conditional invocations, the value will be set to null so it is important to handle null.

Parameters annotated with this annotation must be of type String

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    supportsMultiple
    Does this param support operating over multiple objects without throwing an error?

  • Element Details

    • supportsMultiple

      boolean supportsMultiple
      Does this param support operating over multiple objects without throwing an error? This should be set to true only for conditional delete operations if the server supports multiple deletes via a conditional URL.

      Note that this flag is only a hint to the Conformance statement generator, it does not actually affect how the server itself works.

      Default:
      false