Package ca.uhn.fhir.context

Class RuntimeSearchParam

java.lang.Object

ca.uhn.fhir.context.RuntimeSearchParam

public class RuntimeSearchParam
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RuntimeSearchParam.Component
static enum	RuntimeSearchParam.RuntimeSearchParamStatusEnum

Constructor Summary

Constructors

Constructor	Description
RuntimeSearchParam(RuntimeSearchParam theSp)	Copy constructor
RuntimeSearchParam(IIdType theId, String theUri, String theName, String theDescription, String thePath, RestSearchParameterTypeEnum theParamType, Set<String> theProvidesMembershipInCompartments, Set<String> theTargets, RuntimeSearchParam.RuntimeSearchParamStatusEnum theStatus, ComboSearchParamType theComboSearchParamType, List<RuntimeSearchParam.Component> theComponents, Collection<String> theBase)	Constructor
RuntimeSearchParam(IIdType theId, String theUri, String theName, String theDescription, String thePath, RestSearchParameterTypeEnum theParamType, Set<String> theProvidesMembershipInCompartments, Set<String> theTargets, RuntimeSearchParam.RuntimeSearchParamStatusEnum theStatus, Collection<String> theBase)	Constructor

Method Summary

Modifier and Type	Method	Description
RuntimeSearchParam	addExtension(String theKey, IBaseExtension<?,?> theValue)	Sets user data - This can be used to store any application-specific data
void	addUpliftRefchain(String theCode, String theElementName)
String	encode(String theString)
boolean	equals(Object theO)
Set<String>	getBase()
ComboSearchParamType	getComboSearchParamType()	Returns null if this is not a combo search param type
List<RuntimeSearchParam.Component>	getComponents()
String	getDescription()
List<IBaseExtension<?,?>>	getExtensions(String theKey)	Retrieve user data - This can be used to store any application-specific data
IIdType	getId()
IIdType	getIdUnqualifiedVersionless()
String	getName()
RestSearchParameterTypeEnum	getParamType()
String	getPath()
List<String>	getPathsSplit()
List<String>	getPathsSplitForResourceType(String theResourceName)
Set<String>	getProvidesMembershipInCompartments()	Can return null
RuntimeSearchParam.RuntimeSearchParamStatusEnum	getStatus()
Set<String>	getTargets()
Set<String>	getUpliftRefchainCodes()	Returns a set of all codes associated with uplift refchains for this search parameter.
String	getUri()
int	hashCode()
boolean	hasTargets()
boolean	hasUpliftRefchain(String theCode)	Does this search parameter have an uplift refchain definition for the given code? See the HAPI FHIR documentation for a description of how uplift refchains work.
boolean	hasUpliftRefchains()	Does this search parameter have any uplift refchain definitions? See the HAPI FHIR documentation for a description of how uplift refchains work.
boolean	isEnabledForSearching()	Is this search parameter actually enabled for being used in searches (as opposed to only being used for generating indexes, which might be desired while the search parameter is still being indexed).
void	setEnabledForSearching(boolean theEnabledForSearching)	Is this search parameter actually enabled for being used in searches (as opposed to only being used for generating indexes, which might be desired while the search parameter is still being indexed).
RuntimeSearchParam	setPhoneticEncoder(IPhoneticEncoder thePhoneticEncoder)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RuntimeSearchParam

public RuntimeSearchParam(IIdType theId,
 String theUri,
 String theName,
 String theDescription,
 String thePath,
 RestSearchParameterTypeEnum theParamType,
 Set<String> theProvidesMembershipInCompartments,
 Set<String> theTargets,
 RuntimeSearchParam.RuntimeSearchParamStatusEnum theStatus,
 Collection<String> theBase)

Constructor

RuntimeSearchParam

public RuntimeSearchParam(RuntimeSearchParam theSp)

Copy constructor

RuntimeSearchParam

public RuntimeSearchParam(IIdType theId,
 String theUri,
 String theName,
 String theDescription,
 String thePath,
 RestSearchParameterTypeEnum theParamType,
 Set<String> theProvidesMembershipInCompartments,
 Set<String> theTargets,
 RuntimeSearchParam.RuntimeSearchParamStatusEnum theStatus,
 ComboSearchParamType theComboSearchParamType,
 List<RuntimeSearchParam.Component> theComponents,
 Collection<String> theBase)

Constructor

Method Details

isEnabledForSearching

public boolean isEnabledForSearching()

Is this search parameter actually enabled for being used in searches (as opposed to only being used for generating indexes, which might be desired while the search parameter is still being indexed). This setting defaults to true if it isn't set otherwise.

setEnabledForSearching

public void setEnabledForSearching(boolean theEnabledForSearching)

Is this search parameter actually enabled for being used in searches (as opposed to only being used for generating indexes, which might be desired while the search parameter is still being indexed). This setting defaults to true if it isn't set otherwise.

getComponents

public List<RuntimeSearchParam.Component> getComponents()

getComboSearchParamType

@Nullable
public ComboSearchParamType getComboSearchParamType()

Returns null if this is not a combo search param type

getExtensions

@Nonnull
public List<IBaseExtension<?,?>> getExtensions(String theKey)

Retrieve user data - This can be used to store any application-specific data

addExtension

public RuntimeSearchParam addExtension(String theKey,
 IBaseExtension<?,?> theValue)

Sets user data - This can be used to store any application-specific data

toString

public String toString()

Overrides:

toString in class Object

getId

public IIdType getId()

getIdUnqualifiedVersionless

public IIdType getIdUnqualifiedVersionless()

getUri

public String getUri()

equals

public boolean equals(Object theO)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getBase

public Set<String> getBase()

getTargets

@Nonnull
public Set<String> getTargets()

hasTargets

public boolean hasTargets()

getStatus

public RuntimeSearchParam.RuntimeSearchParamStatusEnum getStatus()

getDescription

public String getDescription()

getName

public String getName()

getParamType

public RestSearchParameterTypeEnum getParamType()

getPath

public String getPath()

getPathsSplit

public List<String> getPathsSplit()

getProvidesMembershipInCompartments

public Set<String> getProvidesMembershipInCompartments()

Can return null

setPhoneticEncoder

public RuntimeSearchParam setPhoneticEncoder(IPhoneticEncoder thePhoneticEncoder)

encode

public String encode(String theString)

getPathsSplitForResourceType

public List<String> getPathsSplitForResourceType(@Nullable
 String theResourceName)

addUpliftRefchain

public void addUpliftRefchain(@Nonnull
 String theCode,
 @Nonnull
 String theElementName)

hasUpliftRefchain

public boolean hasUpliftRefchain(String theCode)

Does this search parameter have an uplift refchain definition for the given code? See the HAPI FHIR documentation for a description of how uplift refchains work.

Since:

6.6.0

getUpliftRefchainCodes

public Set<String> getUpliftRefchainCodes()

Returns a set of all codes associated with uplift refchains for this search parameter. See the HAPI FHIR documentation for a description of how uplift refchains work.

Since:

6.6.0

hasUpliftRefchains

public boolean hasUpliftRefchains()

Does this search parameter have any uplift refchain definitions? See the HAPI FHIR documentation for a description of how uplift refchains work.

Since:

6.6.0