Class OperationDefinition.Parameter

    • Method Detail

      • getName

        public Code getName()
        The name of used to identify the parameter.
        Returns:
        An immutable object of type Code that is non-null.
      • getMin

        public Integer getMin()
        The minimum number of times this parameter SHALL appear in the request or response.
        Returns:
        An immutable object of type Integer that is non-null.
      • getMax

        public String getMax()
        The maximum number of times this element is permitted to appear in the request or response.
        Returns:
        An immutable object of type String that is non-null.
      • getDocumentation

        public String getDocumentation()
        Describes the meaning or use of this parameter.
        Returns:
        An immutable object of type String that may be null.
      • getType

        public FHIRAllTypes getType()
        The type for this parameter.
        Returns:
        An immutable object of type FHIRAllTypes that may be null.
      • getTargetProfile

        public java.util.List<Canonical> getTargetProfile()
        Used when the type is "Reference" or "canonical", and identifies a profile structure or implementation Guide that applies to the target of the reference this parameter refers to. If any profiles are specified, then the content must conform to at least one of them. The URL can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the target resource SHALL conform to at least one profile defined in the implementation guide.
        Returns:
        An unmodifiable list containing immutable objects of type Canonical that may be empty.
      • getSearchType

        public SearchParamType getSearchType()
        How the parameter is understood as a search parameter. This is only used if the parameter type is 'string'.
        Returns:
        An immutable object of type SearchParamType that may be null.
      • accept

        public void accept​(java.lang.String elementName,
                           int elementIndex,
                           Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:
         if (visitor.preVisit(this)) {
             visitor.visitStart(elementName, elementIndex, this);
             if (visitor.visit(elementName, elementIndex, this)) {
                 // visit children
             }
             visitor.visitEnd(elementName, elementIndex, this);
             visitor.postVisit(this);
         }
         
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use
      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object