Package ca.uhn.fhir.rest.annotation

Annotation Type OperationParam

@Retention(RUNTIME) @Target(PARAMETER) public @interface OperationParam

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
    The name of the parameter

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    max
    The maximum number of repetitions allowed for this child.
    int
    min
    The minimum number of repetitions allowed for this child (default is 0)
    Class<? extends IBase>
    type
    The type of the parameter.
    String
    typeName
    Optionally specifies the type of the parameter as a string, such as Coding or base64Binary.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAX_DEFAULT
    Value for max() indicating that the maximum will be inferred from the type.
    static final int
    MAX_UNLIMITED
    Value for max() indicating no maximum

  • Field Details

    • MAX_UNLIMITED

      static final int MAX_UNLIMITED
      Value for max() indicating no maximum
      See Also:

    • MAX_DEFAULT

      static final int MAX_DEFAULT
      Value for max() indicating that the maximum will be inferred from the type. If the type is a single parameter type (e.g. StringDt, TokenParam, IBaseResource) the maximum will be 1.

      If the type is a collection, e.g. List<StringDt> or List<TokenOrListParam> the maximum will be set to *. If the param is a search parameter "and" type, such as TokenAndListParam the maximum will also be set to *

      Since:
      1.5
      See Also:

  • Element Details

    • name

      String name
      The name of the parameter

    • type

      Class<? extends IBase> type
      The type of the parameter. This will only have effect on @OperationParam annotations specified as values for Operation.returnParameters(), otherwise the value will be ignored. Value should be one of:
      • A resource type, e.g. Patient.class
      • A datatype, e.g. StringDt.class or CodeableConceptDt.class
      • A RESTful search parameter type, e.g. StringParam.class
      Default:
      org.hl7.fhir.instance.model.api.IBase.class

    • typeName

      String typeName
      Optionally specifies the type of the parameter as a string, such as Coding or base64Binary. This can be useful if you want to use a generic interface type on the actual method,such as IPrimitiveType or
      invalid @link 
      {@link @org.hl7.fhir.instance.model.api.ICompositeType
      }.
      Default:
      ""

    • min

      int min
      The minimum number of repetitions allowed for this child (default is 0)
      Default:
      0

    • max

      int max
      The maximum number of repetitions allowed for this child. Should be set to MAX_UNLIMITED if there is no limit to the number of repetitions. See MAX_DEFAULT for a description of the default behaviour.
      Default:
      -2