Package org.linuxforhealth.fhir.model.resource

Class TestScript.Builder

    • Method Detail

      • id

        public TestScript.Builder id​(java.lang.String id)
        The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
        Overrides:
        id in class DomainResource.Builder
        Parameters:
        id - Logical id of this artifact
        Returns:
        A reference to this Builder instance

      • meta

        public TestScript.Builder meta​(Meta meta)
        The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
        Overrides:
        meta in class DomainResource.Builder
        Parameters:
        meta - Metadata about the resource
        Returns:
        A reference to this Builder instance

      • implicitRules

        public TestScript.Builder implicitRules​(Uri implicitRules)
        A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
        Overrides:
        implicitRules in class DomainResource.Builder
        Parameters:
        implicitRules - A set of rules under which this content was created
        Returns:
        A reference to this Builder instance

      • language

        public TestScript.Builder language​(Code language)
        The base language in which the resource is written.
        Overrides:
        language in class DomainResource.Builder
        Parameters:
        language - Language of the resource content
        Returns:
        A reference to this Builder instance

      • text

        public TestScript.Builder text​(Narrative text)
        A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
        Overrides:
        text in class DomainResource.Builder
        Parameters:
        text - Text summary of the resource, for human interpretation
        Returns:
        A reference to this Builder instance

      • contained

        public TestScript.Builder contained​(Resource... contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance

      • contained

        public TestScript.Builder contained​(java.util.Collection<Resource> contained)
        These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Overrides:
        contained in class DomainResource.Builder
        Parameters:
        contained - Contained, inline Resources
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • extension

        public TestScript.Builder extension​(Extension... extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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. If any of the elements are null, calling build() will fail.

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

      • extension

        public TestScript.Builder extension​(java.util.Collection<Extension> extension)
        May be used to represent additional information that is not part of the basic definition of the resource. 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. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class DomainResource.Builder
        Parameters:
        extension - Additional content defined by implementations
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • modifierExtension

        public TestScript.Builder modifierExtension​(Extension... modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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. If any of the elements are null, calling build() will fail.

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

      • modifierExtension

        public TestScript.Builder modifierExtension​(java.util.Collection<Extension> modifierExtension)
        May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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. If any of the elements are null, calling build() will fail.

        Overrides:
        modifierExtension in class DomainResource.Builder
        Parameters:
        modifierExtension - Extensions that cannot be ignored
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • url

        public TestScript.Builder url​(Uri url)
        An absolute URI that is used to identify this test script when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this test script is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the test script is stored on different servers.

        This element is required.

        Parameters:
        url - Canonical identifier for this test script, represented as a URI (globally unique)
        Returns:
        A reference to this Builder instance

      • identifier

        public TestScript.Builder identifier​(Identifier identifier)
        A formal identifier that is used to identify this test script when it is represented in other formats, or referenced in a specification, model, design or an instance.
        Parameters:
        identifier - Additional identifier for the test script
        Returns:
        A reference to this Builder instance

      • version

        public TestScript.Builder version​(String version)
        The identifier that is used to identify this version of the test script when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the test script author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
        Parameters:
        version - Business version of the test script
        Returns:
        A reference to this Builder instance

      • name

        public TestScript.Builder name​(String name)
        A natural language name identifying the test script. This name should be usable as an identifier for the module by machine processing applications such as code generation.

        This element is required.

        Parameters:
        name - Name for this test script (computer friendly)
        Returns:
        A reference to this Builder instance

      • title

        public TestScript.Builder title​(String title)
        A short, descriptive, user-friendly title for the test script.
        Parameters:
        title - Name for this test script (human friendly)
        Returns:
        A reference to this Builder instance

      • status

        public TestScript.Builder status​(PublicationStatus status)
        The status of this test script. Enables tracking the life-cycle of the content.

        This element is required.

        Parameters:
        status - draft | active | retired | unknown
        Returns:
        A reference to this Builder instance

      • experimental

        public TestScript.Builder experimental​(Boolean experimental)
        A Boolean value to indicate that this test script is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
        Parameters:
        experimental - For testing purposes, not real usage
        Returns:
        A reference to this Builder instance

      • date

        public TestScript.Builder date​(DateTime date)
        The date (and optionally time) when the test script was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the test script changes.
        Parameters:
        date - Date last changed
        Returns:
        A reference to this Builder instance

      • publisher

        public TestScript.Builder publisher​(String publisher)
        The name of the organization or individual that published the test script.
        Parameters:
        publisher - Name of the publisher (organization or individual)
        Returns:
        A reference to this Builder instance

      • contact

        public TestScript.Builder contact​(ContactDetail... contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance

      • contact

        public TestScript.Builder contact​(java.util.Collection<ContactDetail> contact)
        Contact details to assist a user in finding and communicating with the publisher.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        contact - Contact details for the publisher
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • description

        public TestScript.Builder description​(Markdown description)
        A free text natural language description of the test script from a consumer's perspective.
        Parameters:
        description - Natural language description of the test script
        Returns:
        A reference to this Builder instance

      • useContext

        public TestScript.Builder useContext​(UsageContext... useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance

      • useContext

        public TestScript.Builder useContext​(java.util.Collection<UsageContext> useContext)
        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate test script instances.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        useContext - The context that the content is intended to support
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • jurisdiction

        public TestScript.Builder jurisdiction​(CodeableConcept... jurisdiction)
        A legal or geographic region in which the test script is intended to be used.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction for test script (if applicable)
        Returns:
        A reference to this Builder instance

      • jurisdiction

        public TestScript.Builder jurisdiction​(java.util.Collection<CodeableConcept> jurisdiction)
        A legal or geographic region in which the test script is intended to be used.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        jurisdiction - Intended jurisdiction for test script (if applicable)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • purpose

        public TestScript.Builder purpose​(Markdown purpose)
        Explanation of why this test script is needed and why it has been designed as it has.
        Parameters:
        purpose - Why this test script is defined
        Returns:
        A reference to this Builder instance

      • copyright

        public TestScript.Builder copyright​(Markdown copyright)
        A copyright statement relating to the test script and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the test script.
        Parameters:
        copyright - Use and/or publishing restrictions
        Returns:
        A reference to this Builder instance

      • origin

        public TestScript.Builder origin​(TestScript.Origin... origin)
        An abstract server used in operations within this test script in the origin element.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        origin - An abstract server representing a client or sender in a message exchange
        Returns:
        A reference to this Builder instance

      • origin

        public TestScript.Builder origin​(java.util.Collection<TestScript.Origin> origin)
        An abstract server used in operations within this test script in the origin element.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        origin - An abstract server representing a client or sender in a message exchange
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • destination

        public TestScript.Builder destination​(TestScript.Destination... destination)
        An abstract server used in operations within this test script in the destination element.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        destination - An abstract server representing a destination or receiver in a message exchange
        Returns:
        A reference to this Builder instance

      • destination

        public TestScript.Builder destination​(java.util.Collection<TestScript.Destination> destination)
        An abstract server used in operations within this test script in the destination element.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        destination - An abstract server representing a destination or receiver in a message exchange
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • metadata

        public TestScript.Builder metadata​(TestScript.Metadata metadata)
        The required capability must exist and are assumed to function correctly on the FHIR server being tested.
        Parameters:
        metadata - Required capability that is assumed to function correctly on the FHIR server being tested
        Returns:
        A reference to this Builder instance

      • fixture

        public TestScript.Builder fixture​(TestScript.Fixture... fixture)
        Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        fixture - Fixture in the test script - by reference (uri)
        Returns:
        A reference to this Builder instance

      • fixture

        public TestScript.Builder fixture​(java.util.Collection<TestScript.Fixture> fixture)
        Fixture in the test script - by reference (uri). All fixtures are required for the test script to execute.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        fixture - Fixture in the test script - by reference (uri)
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • profile

        public TestScript.Builder profile​(Reference... profile)
        Reference to the profile to be used for validation.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        profile - Reference of the validation profile
        Returns:
        A reference to this Builder instance

      • profile

        public TestScript.Builder profile​(java.util.Collection<Reference> profile)
        Reference to the profile to be used for validation.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        profile - Reference of the validation profile
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • variable

        public TestScript.Builder variable​(TestScript.Variable... variable)
        Variable is set based either on element value in response body or on header field value in the response headers.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        variable - Placeholder for evaluated elements
        Returns:
        A reference to this Builder instance

      • variable

        public TestScript.Builder variable​(java.util.Collection<TestScript.Variable> variable)
        Variable is set based either on element value in response body or on header field value in the response headers.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        variable - Placeholder for evaluated elements
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • setup

        public TestScript.Builder setup​(TestScript.Setup setup)
        A series of required setup operations before tests are executed.
        Parameters:
        setup - A series of required setup operations before tests are executed
        Returns:
        A reference to this Builder instance

      • test

        public TestScript.Builder test​(TestScript.Test... test)
        A test in this script.

        Adds new element(s) to the existing list. If any of the elements are null, calling build() will fail.

        Parameters:
        test - A test in this script
        Returns:
        A reference to this Builder instance

      • test

        public TestScript.Builder test​(java.util.Collection<TestScript.Test> test)
        A test in this script.

        Replaces the existing list with a new one containing elements from the Collection. If any of the elements are null, calling build() will fail.

        Parameters:
        test - A test in this script
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • teardown

        public TestScript.Builder teardown​(TestScript.Teardown teardown)
        A series of operations required to clean up after all the tests are executed (successfully or otherwise).
        Parameters:
        teardown - A series of required clean up steps
        Returns:
        A reference to this Builder instance

      • validate

        protected void validate​(TestScript testScript)