ca.uhn.fhir.model.dstu.resource

Class Profile.StructureSearchParam

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.Profile.StructureSearchParam

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Profile

public static class Profile.StructureSearchParam
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Profile.structure.searchParam (Search params defined)

Definition: Additional search parameters for implementations to support and/or make use of

Constructor Summary

Constructors

Constructor and Description
Profile.StructureSearchParam()

Method Summary

Methods

Modifier and Type	Method and Description
BoundCodeDt<ResourceTypeEnum>	addTarget() Add a value for target (Types of resource (if a resource reference))
BoundCodeDt<ResourceTypeEnum>	addTarget(ResourceTypeEnum theValue) Add a value for target (Types of resource (if a resource reference)) using an enumerated type.
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType) Returns a list containing all child elements matching a given type
StringDt	getDocumentation() Gets the value(s) for documentation (Contents and meaning of search parameter).
StringDt	getName() Gets the value(s) for name (Name of search parameter).
List<BoundCodeDt<ResourceTypeEnum>>	getTarget() Gets the value(s) for target (Types of resource (if a resource reference)).
BoundCodeDt<ResourceTypeEnum>	getTargetFirstRep() Gets the first repetition for target (Types of resource (if a resource reference)), creating it if it does not already exist.
BoundCodeDt<SearchParamTypeEnum>	getType() Gets the value(s) for type (number | date | string | token | reference | composite | quantity).
StringDt	getXpath() Gets the value(s) for xpath (XPath that extracts the parameter set).
boolean	isEmpty()
Profile.StructureSearchParam	setDocumentation(String theString) Sets the value for documentation (Contents and meaning of search parameter)
Profile.StructureSearchParam	setDocumentation(StringDt theValue) Sets the value(s) for documentation (Contents and meaning of search parameter)
Profile.StructureSearchParam	setName(String theString) Sets the value for name (Name of search parameter)
Profile.StructureSearchParam	setName(StringDt theValue) Sets the value(s) for name (Name of search parameter)
Profile.StructureSearchParam	setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue) Sets the value(s) for target (Types of resource (if a resource reference))
Profile.StructureSearchParam	setTarget(ResourceTypeEnum theValue) Sets the value(s), and clears any existing value(s) for target (Types of resource (if a resource reference))
Profile.StructureSearchParam	setType(BoundCodeDt<SearchParamTypeEnum> theValue) Sets the value(s) for type (number | date | string | token | reference | composite | quantity)
Profile.StructureSearchParam	setType(SearchParamTypeEnum theValue) Sets the value(s) for type (number | date | string | token | reference | composite | quantity)
Profile.StructureSearchParam	setXpath(String theString) Sets the value for xpath (XPath that extracts the parameter set)
Profile.StructureSearchParam	setXpath(StringDt theValue) Sets the value(s) for xpath (XPath that extracts the parameter set)

Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IIdentifiableElement

getElementSpecificId, getId, setElementSpecificId, setId, setId

Constructor Detail

Profile.StructureSearchParam

public Profile.StructureSearchParam()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IElement

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Description copied from interface: ICompositeElement

Returns a list containing all child elements matching a given type

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

Parameters:

theType - The type to match. If set to null, all child elements will be returned

getName

public StringDt getName()

Gets the value(s) for name (Name of search parameter). creating it if it does not exist. Will not return null.

Definition: The name of the standard or custom search parameter

setName

public Profile.StructureSearchParam setName(StringDt theValue)

Sets the value(s) for name (Name of search parameter)

Definition: The name of the standard or custom search parameter

setName

public Profile.StructureSearchParam setName(String theString)

Sets the value for name (Name of search parameter)

Definition: The name of the standard or custom search parameter

getType

public BoundCodeDt<SearchParamTypeEnum> getType()

Gets the value(s) for type (number | date | string | token | reference | composite | quantity). creating it if it does not exist. Will not return null.

Definition: The type of value a search parameter refers to, and how the content is interpreted

setType

public Profile.StructureSearchParam setType(BoundCodeDt<SearchParamTypeEnum> theValue)

Sets the value(s) for type (number | date | string | token | reference | composite | quantity)

Definition: The type of value a search parameter refers to, and how the content is interpreted

setType

public Profile.StructureSearchParam setType(SearchParamTypeEnum theValue)

Sets the value(s) for type (number | date | string | token | reference | composite | quantity)

Definition: The type of value a search parameter refers to, and how the content is interpreted

getDocumentation

public StringDt getDocumentation()

Gets the value(s) for documentation (Contents and meaning of search parameter). creating it if it does not exist. Will not return null.

Definition: A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does

setDocumentation

public Profile.StructureSearchParam setDocumentation(StringDt theValue)

Sets the value(s) for documentation (Contents and meaning of search parameter)

Definition: A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does

setDocumentation

public Profile.StructureSearchParam setDocumentation(String theString)

Sets the value for documentation (Contents and meaning of search parameter)

Definition: A specification for search parameters. For standard parameters, provides additional information on how the parameter is used in this solution. For custom parameters, provides a description of what the parameter does

getXpath

public StringDt getXpath()

Gets the value(s) for xpath (XPath that extracts the parameter set). creating it if it does not exist. Will not return null.

Definition: An XPath expression that returns a set of elements for the search parameter

setXpath

public Profile.StructureSearchParam setXpath(StringDt theValue)

Sets the value(s) for xpath (XPath that extracts the parameter set)

Definition: An XPath expression that returns a set of elements for the search parameter

setXpath

public Profile.StructureSearchParam setXpath(String theString)

Sets the value for xpath (XPath that extracts the parameter set)

Definition: An XPath expression that returns a set of elements for the search parameter

getTarget

public List<BoundCodeDt<ResourceTypeEnum>> getTarget()

Gets the value(s) for target (Types of resource (if a resource reference)). creating it if it does not exist. Will not return null.

Definition: Types of resource (if a resource is referenced)

setTarget

public Profile.StructureSearchParam setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue)

Sets the value(s) for target (Types of resource (if a resource reference))

Definition: Types of resource (if a resource is referenced)

addTarget

public BoundCodeDt<ResourceTypeEnum> addTarget(ResourceTypeEnum theValue)

Add a value for target (Types of resource (if a resource reference)) using an enumerated type. This is intended as a convenience method for situations where the FHIR defined ValueSets are mandatory or contain the desirable codes. If you wish to use codes other than those which are built-in, you may also use the #addType() method.

Definition: Types of resource (if a resource is referenced)

getTargetFirstRep

public BoundCodeDt<ResourceTypeEnum> getTargetFirstRep()

Gets the first repetition for target (Types of resource (if a resource reference)), creating it if it does not already exist.

Definition: Types of resource (if a resource is referenced)

addTarget

public BoundCodeDt<ResourceTypeEnum> addTarget()

Add a value for target (Types of resource (if a resource reference))

Definition: Types of resource (if a resource is referenced)

setTarget

public Profile.StructureSearchParam setTarget(ResourceTypeEnum theValue)

Sets the value(s), and clears any existing value(s) for target (Types of resource (if a resource reference))

Definition: Types of resource (if a resource is referenced)