TestScript.TestScriptVariableComponent (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.Element
  - - org.hl7.fhir.r4.model.BackboneElement
    - - org.hl7.fhir.r4.model.TestScript.TestScriptVariableComponent

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseBackboneElement, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Enclosing class:

TestScript
```
public static class TestScript.TestScriptVariableComponent
extends BackboneElement
implements org.hl7.fhir.instance.model.api.IBaseBackboneElement
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected StringType`	`defaultValue` A default, hard-coded, or user-defined value for this variable.
`protected StringType`	`description` A free text natural language description of the variable and its purpose.
`protected StringType`	`expression` The FHIRPath expression to evaluate against the fixture body.
`protected StringType`	`headerField` Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
`protected StringType`	`hint` Displayable text string with hint help information to the user when entering a default value.
`protected StringType`	`name` Descriptive name for this variable.
`protected StringType`	`path` XPath or JSONPath to evaluate against the fixture body.
`protected IdType`	`sourceId` Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement
modifierExtension

Fields inherited from class org.hl7.fhir.r4.model.Element
extension, id

Constructor Summary

Constructors
Constructor and Description

TestScriptVariableComponent()
Constructor

TestScriptVariableComponent(StringType name)
Constructor

Constructors
Constructor and Description
`TestScriptVariableComponent()` Constructor
`TestScriptVariableComponent(StringType name)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`TestScript.TestScriptVariableComponent`	`copy()`
`void`	`copyValues(TestScript.TestScriptVariableComponent dst)`
`boolean`	`equalsDeep(Base other_)`
`boolean`	`equalsShallow(Base other_)`
`String`	`fhirType()`
`String`	`getDefaultValue()`
`StringType`	`getDefaultValueElement()`
`String`	`getDescription()`
`StringType`	`getDescriptionElement()`
`String`	`getExpression()`
`StringType`	`getExpressionElement()`
`String`	`getHeaderField()`
`StringType`	`getHeaderFieldElement()`
`String`	`getHint()`
`StringType`	`getHintElement()`
`String`	`getName()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`StringType`	`getNameElement()`
`String`	`getPath()`
`StringType`	`getPathElement()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`String`	`getSourceId()`
`IdType`	`getSourceIdElement()`
`String[]`	`getTypesForProperty(int hash, String name)`
`boolean`	`hasDefaultValue()`
`boolean`	`hasDefaultValueElement()`
`boolean`	`hasDescription()`
`boolean`	`hasDescriptionElement()`
`boolean`	`hasExpression()`
`boolean`	`hasExpressionElement()`
`boolean`	`hasHeaderField()`
`boolean`	`hasHeaderFieldElement()`
`boolean`	`hasHint()`
`boolean`	`hasHintElement()`
`boolean`	`hasName()`
`boolean`	`hasNameElement()`
`boolean`	`hasPath()`
`boolean`	`hasPathElement()`
`boolean`	`hasSourceId()`
`boolean`	`hasSourceIdElement()`
`boolean`	`isEmpty()`
`protected void`	`listChildren(List<Property> children)`
`Base`	`makeProperty(int hash, String name)`
`TestScript.TestScriptVariableComponent`	`setDefaultValue(String value)`
`TestScript.TestScriptVariableComponent`	`setDefaultValueElement(StringType value)`
`TestScript.TestScriptVariableComponent`	`setDescription(String value)`
`TestScript.TestScriptVariableComponent`	`setDescriptionElement(StringType value)`
`TestScript.TestScriptVariableComponent`	`setExpression(String value)`
`TestScript.TestScriptVariableComponent`	`setExpressionElement(StringType value)`
`TestScript.TestScriptVariableComponent`	`setHeaderField(String value)`
`TestScript.TestScriptVariableComponent`	`setHeaderFieldElement(StringType value)`
`TestScript.TestScriptVariableComponent`	`setHint(String value)`
`TestScript.TestScriptVariableComponent`	`setHintElement(StringType value)`
`TestScript.TestScriptVariableComponent`	`setName(String value)`
`TestScript.TestScriptVariableComponent`	`setNameElement(StringType value)`
`TestScript.TestScriptVariableComponent`	`setPath(String value)`
`TestScript.TestScriptVariableComponent`	`setPathElement(StringType value)`
`Base`	`setProperty(int hash, String name, Base value)`
`Base`	`setProperty(String name, Base value)`
`TestScript.TestScriptVariableComponent`	`setSourceId(String value)`
`TestScript.TestScriptVariableComponent`	`setSourceIdElement(IdType value)`

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement
addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getModifierExtension, getModifierExtensionFirstRep, hasModifierExtension, setModifierExtension

Methods inherited from class org.hl7.fhir.r4.model.Element
addExtension, addExtension, addExtension, copyValues, getExtension, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionString, getId, getIdBase, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions
addExtension, getExtension, hasExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
addModifierExtension, getModifierExtension, hasModifierExtension

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement
getUserData, setUserData

- Field Detail
  - name
```
protected StringType name
```
    Descriptive name for this variable.
  - defaultValue
```
protected StringType defaultValue
```
    A default, hard-coded, or user-defined value for this variable.
  - description
```
protected StringType description
```
    A free text natural language description of the variable and its purpose.
  - expression
```
protected StringType expression
```
    The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
  - headerField
```
protected StringType headerField
```
    Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
  - hint
```
protected StringType hint
```
    Displayable text string with hint help information to the user when entering a default value.
  - path
```
protected StringType path
```
    XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
  - sourceId
```
protected IdType sourceId
```
    Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
- Constructor Detail
  - TestScriptVariableComponent
```
public TestScriptVariableComponent()
```
    Constructor
  - TestScriptVariableComponent
```
public TestScriptVariableComponent(StringType name)
```
    Constructor
- Method Detail
  - getNameElement
```
public StringType getNameElement()
```
    Returns:
    
    name (Descriptive name for this variable.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - hasNameElement
```
public boolean hasNameElement()
```
  - hasName
```
public boolean hasName()
```
  - setNameElement
```
public TestScript.TestScriptVariableComponent setNameElement(StringType value)
```
    Parameters:
    
    value - name (Descriptive name for this variable.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
  - getName
```
public String getName()
```
    Returns:
    
    Descriptive name for this variable.
  - setName
```
public TestScript.TestScriptVariableComponent setName(String value)
```
    Parameters:
    
    value - Descriptive name for this variable.
  - getDefaultValueElement
```
public StringType getDefaultValueElement()
```
    Returns:
    
    defaultValue (A default, hard-coded, or user-defined value for this variable.). This is the underlying object with id, value and extensions. The accessor "getDefaultValue" gives direct access to the value
  - hasDefaultValueElement
```
public boolean hasDefaultValueElement()
```
  - hasDefaultValue
```
public boolean hasDefaultValue()
```
  - setDefaultValueElement
```
public TestScript.TestScriptVariableComponent setDefaultValueElement(StringType value)
```
    Parameters:
    
    value - defaultValue (A default, hard-coded, or user-defined value for this variable.). This is the underlying object with id, value and extensions. The accessor "getDefaultValue" gives direct access to the value
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns:
    
    A default, hard-coded, or user-defined value for this variable.
  - setDefaultValue
```
public TestScript.TestScriptVariableComponent setDefaultValue(String value)
```
    Parameters:
    
    value - A default, hard-coded, or user-defined value for this variable.
  - getDescriptionElement
```
public StringType getDescriptionElement()
```
    Returns:
    
    description (A free text natural language description of the variable and its purpose.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - hasDescriptionElement
```
public boolean hasDescriptionElement()
```
  - hasDescription
```
public boolean hasDescription()
```
  - setDescriptionElement
```
public TestScript.TestScriptVariableComponent setDescriptionElement(StringType value)
```
    Parameters:
    
    value - description (A free text natural language description of the variable and its purpose.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
  - getDescription
```
public String getDescription()
```
    Returns:
    
    A free text natural language description of the variable and its purpose.
  - setDescription
```
public TestScript.TestScriptVariableComponent setDescription(String value)
```
    Parameters:
    
    value - A free text natural language description of the variable and its purpose.
  - getExpressionElement
```
public StringType getExpressionElement()
```
    Returns:
    
    expression (The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.). This is the underlying object with id, value and extensions. The accessor "getExpression" gives direct access to the value
  - hasExpressionElement
```
public boolean hasExpressionElement()
```
  - hasExpression
```
public boolean hasExpression()
```
  - setExpressionElement
```
public TestScript.TestScriptVariableComponent setExpressionElement(StringType value)
```
    Parameters:
    
    value - expression (The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.). This is the underlying object with id, value and extensions. The accessor "getExpression" gives direct access to the value
  - getExpression
```
public String getExpression()
```
    Returns:
    
    The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
  - setExpression
```
public TestScript.TestScriptVariableComponent setExpression(String value)
```
    Parameters:
    
    value - The FHIRPath expression to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
  - getHeaderFieldElement
```
public StringType getHeaderFieldElement()
```
    Returns:
    
    headerField (Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.). This is the underlying object with id, value and extensions. The accessor "getHeaderField" gives direct access to the value
  - hasHeaderFieldElement
```
public boolean hasHeaderFieldElement()
```
  - hasHeaderField
```
public boolean hasHeaderField()
```
  - setHeaderFieldElement
```
public TestScript.TestScriptVariableComponent setHeaderFieldElement(StringType value)
```
    Parameters:
    
    value - headerField (Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.). This is the underlying object with id, value and extensions. The accessor "getHeaderField" gives direct access to the value
  - getHeaderField
```
public String getHeaderField()
```
    Returns:
    
    Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
  - setHeaderField
```
public TestScript.TestScriptVariableComponent setHeaderField(String value)
```
    Parameters:
    
    value - Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
  - getHintElement
```
public StringType getHintElement()
```
    Returns:
    
    hint (Displayable text string with hint help information to the user when entering a default value.). This is the underlying object with id, value and extensions. The accessor "getHint" gives direct access to the value
  - hasHintElement
```
public boolean hasHintElement()
```
  - hasHint
```
public boolean hasHint()
```
  - setHintElement
```
public TestScript.TestScriptVariableComponent setHintElement(StringType value)
```
    Parameters:
    
    value - hint (Displayable text string with hint help information to the user when entering a default value.). This is the underlying object with id, value and extensions. The accessor "getHint" gives direct access to the value
  - getHint
```
public String getHint()
```
    Returns:
    
    Displayable text string with hint help information to the user when entering a default value.
  - setHint
```
public TestScript.TestScriptVariableComponent setHint(String value)
```
    Parameters:
    
    value - Displayable text string with hint help information to the user when entering a default value.
  - getPathElement
```
public StringType getPathElement()
```
    Returns:
    
    path (XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.). This is the underlying object with id, value and extensions. The accessor "getPath" gives direct access to the value
  - hasPathElement
```
public boolean hasPathElement()
```
  - hasPath
```
public boolean hasPath()
```
  - setPathElement
```
public TestScript.TestScriptVariableComponent setPathElement(StringType value)
```
    Parameters:
    
    value - path (XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.). This is the underlying object with id, value and extensions. The accessor "getPath" gives direct access to the value
  - getPath
```
public String getPath()
```
    Returns:
    
    XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
  - setPath
```
public TestScript.TestScriptVariableComponent setPath(String value)
```
    Parameters:
    
    value - XPath or JSONPath to evaluate against the fixture body. When variables are defined, only one of either expression, headerField or path must be specified.
  - getSourceIdElement
```
public IdType getSourceIdElement()
```
    Returns:
    
    sourceId (Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.). This is the underlying object with id, value and extensions. The accessor "getSourceId" gives direct access to the value
  - hasSourceIdElement
```
public boolean hasSourceIdElement()
```
  - hasSourceId
```
public boolean hasSourceId()
```
  - setSourceIdElement
```
public TestScript.TestScriptVariableComponent setSourceIdElement(IdType value)
```
    Parameters:
    
    value - sourceId (Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.). This is the underlying object with id, value and extensions. The accessor "getSourceId" gives direct access to the value
  - getSourceId
```
public String getSourceId()
```
    Returns:
    
    Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
  - setSourceId
```
public TestScript.TestScriptVariableComponent setSourceId(String value)
```
    Parameters:
    
    value - Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
  - listChildren
```
protected void listChildren(List<Property> children)
```
    Overrides:
    
    listChildren in class BackboneElement
  - getNamedProperty
```
public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getNamedProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getProperty
```
public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - setProperty
```
public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    setProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - makeProperty
```
public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    makeProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - getTypesForProperty
```
public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    getTypesForProperty in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - addChild
```
public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException
```
    Overrides:
    
    addChild in class BackboneElement
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - copy
```
public TestScript.TestScriptVariableComponent copy()
```
    Specified by:
    
    copy in class BackboneElement
  - copyValues
```
public void copyValues(TestScript.TestScriptVariableComponent dst)
```
  - equalsDeep
```
public boolean equalsDeep(Base other_)
```
    Overrides:
    
    equalsDeep in class BackboneElement
  - equalsShallow
```
public boolean equalsShallow(Base other_)
```
    Overrides:
    
    equalsShallow in class BackboneElement
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    isEmpty in class BackboneElement
  - fhirType
```
public String fhirType()
```
    Specified by:
    
    fhirType in interface org.hl7.fhir.instance.model.api.IBase
    
    Overrides:
    
    fhirType in class BackboneElement

Class TestScript.TestScriptVariableComponent

Field Summary

Fields inherited from class org.hl7.fhir.r4.model.BackboneElement

Fields inherited from class org.hl7.fhir.r4.model.Element

Constructor Summary

Method Summary

Methods inherited from class org.hl7.fhir.r4.model.BackboneElement

Methods inherited from class org.hl7.fhir.r4.model.Element

Methods inherited from class org.hl7.fhir.r4.model.Base

Methods inherited from class java.lang.Object

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

Field Detail

name

defaultValue

description

expression

headerField

hint

path

sourceId

Constructor Detail

TestScriptVariableComponent

TestScriptVariableComponent

Method Detail

getNameElement

hasNameElement

hasName

setNameElement

getName

setName

getDefaultValueElement

hasDefaultValueElement

hasDefaultValue

setDefaultValueElement

getDefaultValue

setDefaultValue

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getExpressionElement

hasExpressionElement

hasExpression

setExpressionElement

getExpression

setExpression

getHeaderFieldElement

hasHeaderFieldElement

hasHeaderField

setHeaderFieldElement

getHeaderField

setHeaderField

getHintElement

hasHintElement

hasHint

setHintElement

getHint

setHint

getPathElement

hasPathElement

hasPath

setPathElement

getPath

setPath

getSourceIdElement

hasSourceIdElement

hasSourceId

setSourceIdElement

getSourceId

setSourceId

listChildren

getNamedProperty

getProperty

setProperty

setProperty