ca.uhn.fhir.model.dstu.resource

Class Conformance.RestResourceSearchParam

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseIdentifiableElement

ca.uhn.fhir.model.dstu.resource.Conformance.RestResourceSearchParam

All Implemented Interfaces:

ICompositeElement, IElement, IIdentifiableElement, IResourceBlock, ISupportsUndeclaredExtensions

Enclosing class:

Conformance

public static class Conformance.RestResourceSearchParam
extends BaseIdentifiableElement
implements IResourceBlock

Block class for child element: Conformance.rest.resource.searchParam (Additional search params defined)

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

Constructor Summary

Constructors

Constructor and Description
Conformance.RestResourceSearchParam()

Method Summary

Methods

Modifier and Type	Method and Description
StringDt	addChain() Adds and returns a new value for chain (Chained names supported)
Conformance.RestResourceSearchParam	addChain(String theString) Adds a new value for chain (Chained names supported)
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
List<StringDt>	getChain() Gets the value(s) for chain (Chained names supported).
StringDt	getChainFirstRep() Gets the first repetition for chain (Chained names supported), creating it if it does not already exist.
UriDt	getDefinition() Gets the value(s) for definition (Source of definition for parameter).
StringDt	getDocumentation() Gets the value(s) for documentation (Server-specific usage).
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).
boolean	isEmpty()
Conformance.RestResourceSearchParam	setChain(List<StringDt> theValue) Sets the value(s) for chain (Chained names supported)
Conformance.RestResourceSearchParam	setDefinition(String theUri) Sets the value for definition (Source of definition for parameter)
Conformance.RestResourceSearchParam	setDefinition(UriDt theValue) Sets the value(s) for definition (Source of definition for parameter)
Conformance.RestResourceSearchParam	setDocumentation(String theString) Sets the value for documentation (Server-specific usage)
Conformance.RestResourceSearchParam	setDocumentation(StringDt theValue) Sets the value(s) for documentation (Server-specific usage)
Conformance.RestResourceSearchParam	setName(String theString) Sets the value for name (Name of search parameter)
Conformance.RestResourceSearchParam	setName(StringDt theValue) Sets the value(s) for name (Name of search parameter)
Conformance.RestResourceSearchParam	setTarget(List<BoundCodeDt<ResourceTypeEnum>> theValue) Sets the value(s) for target (Types of resource (if a resource reference))
Conformance.RestResourceSearchParam	setTarget(ResourceTypeEnum theValue) Sets the value(s), and clears any existing value(s) for target (Types of resource (if a resource reference))
Conformance.RestResourceSearchParam	setType(BoundCodeDt<SearchParamTypeEnum> theValue) Sets the value(s) for type (number | date | string | token | reference | composite | quantity)
Conformance.RestResourceSearchParam	setType(SearchParamTypeEnum theValue) Sets the value(s) for type (number | date | string | token | reference | composite | quantity)

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

Conformance.RestResourceSearchParam

public Conformance.RestResourceSearchParam()

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 search parameter used in the interface

setName

public Conformance.RestResourceSearchParam setName(StringDt theValue)

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

Definition: The name of the search parameter used in the interface

setName

public Conformance.RestResourceSearchParam setName(String theString)

Sets the value for name (Name of search parameter)

Definition: The name of the search parameter used in the interface

getDefinition

public UriDt getDefinition()

Gets the value(s) for definition (Source of definition for parameter). creating it if it does not exist. Will not return null.

Definition: A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter

setDefinition

public Conformance.RestResourceSearchParam setDefinition(UriDt theValue)

Sets the value(s) for definition (Source of definition for parameter)

Definition: A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter

setDefinition

public Conformance.RestResourceSearchParam setDefinition(String theUri)

Sets the value for definition (Source of definition for parameter)

Definition: A formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the 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 Conformance.RestResourceSearchParam 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 Conformance.RestResourceSearchParam 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 (Server-specific usage). creating it if it does not exist. Will not return null.

Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

setDocumentation

public Conformance.RestResourceSearchParam setDocumentation(StringDt theValue)

Sets the value(s) for documentation (Server-specific usage)

Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

setDocumentation

public Conformance.RestResourceSearchParam setDocumentation(String theString)

Sets the value for documentation (Server-specific usage)

Definition: This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

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 Conformance.RestResourceSearchParam 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 Conformance.RestResourceSearchParam 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)

getChain

public List<StringDt> getChain()

Gets the value(s) for chain (Chained names supported). creating it if it does not exist. Will not return null.

Definition:

setChain

public Conformance.RestResourceSearchParam setChain(List<StringDt> theValue)

Sets the value(s) for chain (Chained names supported)

Definition:

addChain

public StringDt addChain()

Adds and returns a new value for chain (Chained names supported)

Definition:

getChainFirstRep

public StringDt getChainFirstRep()

Gets the first repetition for chain (Chained names supported), creating it if it does not already exist.

Definition:

addChain

public Conformance.RestResourceSearchParam addChain(String theString)

Adds a new value for chain (Chained names supported)

Definition:

Returns:

Returns a reference to this object, to allow for simple chaining.