Interface ISearchParamRegistry

All Known Implementing Classes:
RestfulServerConfiguration

public interface ISearchParamRegistry
  • Method Details

    • getActiveSearchParam

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

      Map<String,​ca.uhn.fhir.context.RuntimeSearchParam> 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
    • getActiveUniqueSearchParams

      default List<ca.uhn.fhir.context.RuntimeSearchParam> getActiveUniqueSearchParams​(String theResourceName)
    • getActiveUniqueSearchParams

      default List<ca.uhn.fhir.context.RuntimeSearchParam> getActiveUniqueSearchParams​(String theResourceName, Set<String> theParamNames)
    • getValidSearchParameterNamesIncludingMeta

      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