Class CapabilityStatement.Rest.Resource.SearchParam

  • All Implemented Interfaces:
    Visitable
    Enclosing class:
    CapabilityStatement.Rest.Resource

    public static class CapabilityStatement.Rest.Resource.SearchParam
    extends BackboneElement
    Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementation.
    • Method Detail

      • getName

        public String getName()
        The name of the search parameter used in the interface.
        Returns:
        An immutable object of type String that is non-null.
      • getDefinition

        public Canonical getDefinition()
        An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [SearchParameter.url](searchparameter-definitions. html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.
        Returns:
        An immutable object of type Canonical that may be null.
      • getType

        public SearchParamType getType()
        The type of value a search parameter refers to, and how the content is interpreted.
        Returns:
        An immutable object of type SearchParamType that is non-null.
      • getDocumentation

        public Markdown getDocumentation()
        This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
        Returns:
        An immutable object of type Markdown 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