Package ca.uhn.fhir.rest.server.util
Interface ISearchParamRegistry
- All Known Implementing Classes:
FhirContextSearchParamRegistry
,RestfulServerConfiguration
public interface ISearchParamRegistry
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
Request that the cache be refreshed now, in the current threaddefault Optional
<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParamById
(String theResourceName, org.hl7.fhir.instance.model.api.IIdType theId) default List
<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParams
(String theResourceName) default List
<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParams
(String theResourceName, ca.uhn.fhir.context.ComboSearchParamType theParamType) default List
<ca.uhn.fhir.context.RuntimeSearchParam> getActiveComboSearchParams
(String theResourceName, Set<String> theParamNames) ca.uhn.fhir.context.RuntimeSearchParam
getActiveSearchParam
(String theResourceName, String theParamName) ca.uhn.fhir.context.RuntimeSearchParam
getActiveSearchParamByUrl
(String theUrl) Fetch a SearchParameter by URLgetActiveSearchParams
(String theResourceName) default ca.uhn.fhir.context.RuntimeSearchParam
getRuntimeSearchParam
(String theResourceType, String theParamName) Find a search param for a resource.default ResourceSearchParams
getRuntimeSearchParams
(String theResourceType) Get all the search params for a resource.default Collection
<String> getValidSearchParameterNamesIncludingMeta
(String theResourceName) Returns a collection containing all of the valid active search parameters.default boolean
Return true if this registry is initialized and ready to handle searches and use its cache.default void
Request that the cache be refreshed at the next convenient time (in a different thread)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.
-
Method Details
-
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
- Returns:
- Returns all active search params for the given resource
-
forceRefresh
Request that the cache be refreshed now, in the current thread -
requestRefresh
Request that the cache be refreshed at the next convenient time (in a different thread) -
setPhoneticEncoder
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
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
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
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.
-