Package com.ibm.fhir.model.resource

Class TestScript.Variable.Builder

    • Method Detail

      • id

        public TestScript.Variable.Builder id​(String id)
        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
        Overrides:
        id in class BackboneElement.Builder
        Parameters:
        id - Unique id for inter-element referencing
        Returns:
        A reference to this Builder instance

      • extension

        public TestScript.Variable.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Adds new element(s) to the existing list

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • extension

        public TestScript.Variable.Builder extension​(Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        extension in class BackboneElement.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public TestScript.Variable.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Adds new element(s) to the existing list

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • modifierExtension

        public TestScript.Variable.Builder modifierExtension​(Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        Replaces the existing list with a new one containing elements from the Collection

        Overrides:
        modifierExtension in class BackboneElement.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored even if unrecognized
        Returns:
        A reference to this Builder instance

      • name

        public TestScript.Variable.Builder name​(String name)
        Descriptive name for this variable.

        This element is required.

        Parameters:
        name - Descriptive name for this variable
        Returns:
        A reference to this Builder instance

      • defaultValue

        public TestScript.Variable.Builder defaultValue​(String defaultValue)
        A default, hard-coded, or user-defined value for this variable.
        Parameters:
        defaultValue - Default, hard-coded, or user-defined value for this variable
        Returns:
        A reference to this Builder instance

      • description

        public TestScript.Variable.Builder description​(String description)
        A free text natural language description of the variable and its purpose.
        Parameters:
        description - Natural language description of the variable
        Returns:
        A reference to this Builder instance

      • expression

        public TestScript.Variable.Builder expression​(String 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.
        Parameters:
        expression - The FHIRPath expression against the fixture body
        Returns:
        A reference to this Builder instance

      • headerField

        public TestScript.Variable.Builder headerField​(String headerField)
        Will be used to grab the HTTP header field value from the headers that sourceId is pointing to.
        Parameters:
        headerField - HTTP header field name for source
        Returns:
        A reference to this Builder instance

      • hint

        public TestScript.Variable.Builder hint​(String hint)
        Displayable text string with hint help information to the user when entering a default value.
        Parameters:
        hint - Hint help text for default value to enter
        Returns:
        A reference to this Builder instance

      • path

        public TestScript.Variable.Builder path​(String 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.
        Parameters:
        path - XPath or JSONPath against the fixture body
        Returns:
        A reference to this Builder instance

      • sourceId

        public TestScript.Variable.Builder sourceId​(Id sourceId)
        Fixture to evaluate the XPath/JSONPath expression or the headerField against within this variable.
        Parameters:
        sourceId - Fixture Id of source expression or headerField within this variable
        Returns:
        A reference to this Builder instance