Package ca.uhn.fhir.rest.server.util

Interface ISearchParamRegistry

All Known Implementing Classes:
FhirContextSearchParamRegistry, RestfulServerConfiguration
public interface ISearchParamRegistry

  • Method Details

    • isInitialized

      default boolean isInitialized()
      Return true if this registry is initialized and ready to handle searches and use its cache. Return false if cache has not been initialized.

    • getActiveSearchParam

      ca.uhn.fhir.context.RuntimeSearchParam getActiveSearchParam(String theResourceName, String theParamName)
      Returns:
      Returns null if no match

    • getActiveSearchParams

      ResourceSearchParams getActiveSearchParams(String theResourceName)
      Returns:
      Returns all active search params for the given resource

    • forceRefresh

      default void forceRefresh()
      Request that the cache be refreshed now, in the current thread

    • requestRefresh

      default void requestRefresh()
      Request that the cache be refreshed at the next convenient time (in a different thread)

    • setPhoneticEncoder

      default void setPhoneticEncoder(ca.uhn.fhir.context.phonetic.IPhoneticEncoder thePhoneticEncoder)
      When indexing a HumanName, if a StringEncoder is set in the context, then the "phonetic" search parameter will normalize the String using this encoder.
      Since:
      5.1.0

    • getActiveComboSearchParams

      default List<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParams(String theResourceName)

    • getActiveComboSearchParams

      default List<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParams(String theResourceName, ca.uhn.fhir.context.ComboSearchParamType theParamType)

    • getActiveComboSearchParamById

      default Optional<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParamById(String theResourceName, org.hl7.fhir.instance.model.api.IIdType theId)

    • getActiveComboSearchParams

      default List<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParams(String theResourceName, Set<String> theParamNames)

    • getValidSearchParameterNamesIncludingMeta

      default Collection<String> getValidSearchParameterNamesIncludingMeta(String theResourceName)
      Returns a collection containing all of the valid active search parameters. This method is intended for creating error messages for users as opposed to actual search processing. It will include meta parameters such as _id and _lastUpdated.

    • getActiveSearchParamByUrl

      @Nullable ca.uhn.fhir.context.RuntimeSearchParam getActiveSearchParamByUrl(String theUrl)
      Fetch a SearchParameter by URL
      Returns:
      Returns null if it can't be found

    • getRuntimeSearchParam

      default ca.uhn.fhir.context.RuntimeSearchParam getRuntimeSearchParam(String theResourceType, String theParamName)
      Find a search param for a resource. First, check the resource itself, then check the top-level `Resource` resource.
      Parameters:
      theResourceType - the resource type.
      theParamName - the search parameter name.
      Returns:
      the RuntimeSearchParam that is found.

    • getRuntimeSearchParams

      default ResourceSearchParams getRuntimeSearchParams(String theResourceType)
      Get all the search params for a resource. First, check the resource itself, then check the top-level `Resource` resource and combine the two.
      Parameters:
      theResourceType - the resource type.
      Returns:
      the ResourceSearchParams that has all the search params.