Class OperationDefinition.Parameter

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IResourceBlock, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase
    Enclosing class:
    OperationDefinition

    public static class OperationDefinition.Parameter
    extends ca.uhn.fhir.model.api.BaseIdentifiableElement
    implements ca.uhn.fhir.model.api.IResourceBlock
    Block class for child element: OperationDefinition.parameter ()

    Definition: The parameters for the operation/query

    See Also:
    Serialized Form
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getNameElement

        public ca.uhn.fhir.model.primitive.CodeDt getNameElement()
        Gets the value(s) for name (). creating it if it does not exist. Will not return null.

        Definition: The name of used to identify the parameter

      • getName

        public String getName()
        Gets the value(s) for name (). creating it if it does not exist. This method may return null.

        Definition: The name of used to identify the parameter

      • setName

        public OperationDefinition.Parameter setName​(ca.uhn.fhir.model.primitive.CodeDt theValue)
        Sets the value(s) for name ()

        Definition: The name of used to identify the parameter

      • getUseElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<OperationParameterUseEnumgetUseElement()
        Gets the value(s) for use (). creating it if it does not exist. Will not return null.

        Definition: Whether this is an input or an output parameter

      • getUse

        public String getUse()
        Gets the value(s) for use (). creating it if it does not exist. This method may return null.

        Definition: Whether this is an input or an output parameter

      • getMinElement

        public ca.uhn.fhir.model.primitive.IntegerDt getMinElement()
        Gets the value(s) for min (). creating it if it does not exist. Will not return null.

        Definition: The minimum number of times this parameter SHALL appear in the request or response

      • getMin

        public Integer getMin()
        Gets the value(s) for min (). creating it if it does not exist. This method may return null.

        Definition: The minimum number of times this parameter SHALL appear in the request or response

      • setMin

        public OperationDefinition.Parameter setMin​(ca.uhn.fhir.model.primitive.IntegerDt theValue)
        Sets the value(s) for min ()

        Definition: The minimum number of times this parameter SHALL appear in the request or response

      • setMin

        public OperationDefinition.Parameter setMin​(int theInteger)
        Sets the value for min ()

        Definition: The minimum number of times this parameter SHALL appear in the request or response

      • getMaxElement

        public ca.uhn.fhir.model.primitive.StringDt getMaxElement()
        Gets the value(s) for max (). creating it if it does not exist. Will not return null.

        Definition: The maximum number of times this element is permitted to appear in the request or response

      • getMax

        public String getMax()
        Gets the value(s) for max (). creating it if it does not exist. This method may return null.

        Definition: The maximum number of times this element is permitted to appear in the request or response

      • setMax

        public OperationDefinition.Parameter setMax​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for max ()

        Definition: The maximum number of times this element is permitted to appear in the request or response

      • setMax

        public OperationDefinition.Parameter setMax​(String theString)
        Sets the value for max ()

        Definition: The maximum number of times this element is permitted to appear in the request or response

      • getDocumentationElement

        public ca.uhn.fhir.model.primitive.StringDt getDocumentationElement()
        Gets the value(s) for documentation (). creating it if it does not exist. Will not return null.

        Definition: Describes the meaning or use of this parameter

      • getDocumentation

        public String getDocumentation()
        Gets the value(s) for documentation (). creating it if it does not exist. This method may return null.

        Definition: Describes the meaning or use of this parameter

      • getTypeElement

        public ca.uhn.fhir.model.primitive.CodeDt getTypeElement()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: The type for this parameter

      • getType

        public String getType()
        Gets the value(s) for type (). creating it if it does not exist. This method may return null.

        Definition: The type for this parameter

      • getProfile

        public ResourceReferenceDt getProfile()
        Gets the value(s) for profile (). creating it if it does not exist. Will not return null.

        Definition: A profile the specifies the rules that this parameter must conform to

      • getBinding

        public OperationDefinition.ParameterBinding getBinding()
        Gets the value(s) for binding (). creating it if it does not exist. Will not return null.

        Definition: Binds to a value set if this parameter is coded (code, Coding, CodeableConcept)