Package com.ibm.fhir.model.resource

Class TestScript.Setup.Action.Assert.Builder

    • Method Detail

      • id

        public TestScript.Setup.Action.Assert.Builder id​(java.lang.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.Setup.Action.Assert.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. If any of the elements are null, calling build() will fail.

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

      • extension

        public TestScript.Setup.Action.Assert.Builder extension​(java.util.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. If any of the elements are null, calling build() will fail.

        Overrides:
        extension in class BackboneElement.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.Setup.Action.Assert.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. If any of the elements are null, calling build() will fail.

        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.Setup.Action.Assert.Builder modifierExtension​(java.util.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. If any of the elements are null, calling build() will fail.

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

      • label

        public TestScript.Setup.Action.Assert.Builder label​(String label)
        The label would be used for tracking/logging purposes by test engines.
        Parameters:
        label - Tracking/logging assertion label
        Returns:
        A reference to this Builder instance

      • description

        public TestScript.Setup.Action.Assert.Builder description​(String description)
        The description would be used by test engines for tracking and reporting purposes.
        Parameters:
        description - Tracking/reporting assertion description
        Returns:
        A reference to this Builder instance

      • compareToSourceId

        public TestScript.Setup.Action.Assert.Builder compareToSourceId​(String compareToSourceId)
        Id of the source fixture used as the contents to be evaluated by either the "source/expression" or "sourceId/path" definition.
        Parameters:
        compareToSourceId - Id of the source fixture to be evaluated
        Returns:
        A reference to this Builder instance

      • compareToSourceExpression

        public TestScript.Setup.Action.Assert.Builder compareToSourceExpression​(String compareToSourceExpression)
        The FHIRPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
        Parameters:
        compareToSourceExpression - The FHIRPath expression to evaluate against the source fixture
        Returns:
        A reference to this Builder instance

      • compareToSourcePath

        public TestScript.Setup.Action.Assert.Builder compareToSourcePath​(String compareToSourcePath)
        XPath or JSONPath expression to evaluate against the source fixture. When compareToSourceId is defined, either compareToSourceExpression or compareToSourcePath must be defined, but not both.
        Parameters:
        compareToSourcePath - XPath or JSONPath expression to evaluate against the source fixture
        Returns:
        A reference to this Builder instance

      • contentType

        public TestScript.Setup.Action.Assert.Builder contentType​(Code contentType)
        The mime-type contents to compare against the request or response message 'Content-Type' header.
        Parameters:
        contentType - Mime type to compare against the 'Content-Type' header
        Returns:
        A reference to this Builder instance

      • expression

        public TestScript.Setup.Action.Assert.Builder expression​(String expression)
        The FHIRPath expression to be evaluated against the request or response message contents - HTTP headers and payload.
        Parameters:
        expression - The FHIRPath expression to be evaluated
        Returns:
        A reference to this Builder instance

      • headerField

        public TestScript.Setup.Action.Assert.Builder headerField​(String headerField)
        The HTTP header field name e.g. 'Location'.
        Parameters:
        headerField - HTTP header field name
        Returns:
        A reference to this Builder instance

      • minimumId

        public TestScript.Setup.Action.Assert.Builder minimumId​(String minimumId)
        The ID of a fixture. Asserts that the response contains at a minimum the fixture specified by minimumId.
        Parameters:
        minimumId - Fixture Id of minimum content resource
        Returns:
        A reference to this Builder instance

      • navigationLinks

        public TestScript.Setup.Action.Assert.Builder navigationLinks​(Boolean navigationLinks)
        Whether or not the test execution performs validation on the bundle navigation links.
        Parameters:
        navigationLinks - Perform validation on navigation links?
        Returns:
        A reference to this Builder instance

      • operator

        public TestScript.Setup.Action.Assert.Builder operator​(AssertionOperatorType operator)
        The operator type defines the conditional behavior of the assert. If not defined, the default is equals.
        Parameters:
        operator - equals | notEquals | in | notIn | greaterThan | lessThan | empty | notEmpty | contains | notContains | eval
        Returns:
        A reference to this Builder instance

      • path

        public TestScript.Setup.Action.Assert.Builder path​(String path)
        The XPath or JSONPath expression to be evaluated against the fixture representing the response received from server.
        Parameters:
        path - XPath or JSONPath expression
        Returns:
        A reference to this Builder instance

      • requestMethod

        public TestScript.Setup.Action.Assert.Builder requestMethod​(TestScriptRequestMethodCode requestMethod)
        The request method or HTTP operation code to compare against that used by the client system under test.
        Parameters:
        requestMethod - delete | get | options | patch | post | put | head
        Returns:
        A reference to this Builder instance

      • requestURL

        public TestScript.Setup.Action.Assert.Builder requestURL​(String requestURL)
        The value to use in a comparison against the request URL path string.
        Parameters:
        requestURL - Request URL comparison value
        Returns:
        A reference to this Builder instance

      • response

        public TestScript.Setup.Action.Assert.Builder response​(AssertionResponseTypes response)
        okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable.
        Parameters:
        response - okay | created | noContent | notModified | bad | forbidden | notFound | methodNotAllowed | conflict | gone | preconditionFailed | unprocessable
        Returns:
        A reference to this Builder instance

      • responseCode

        public TestScript.Setup.Action.Assert.Builder responseCode​(String responseCode)
        The value of the HTTP response code to be tested.
        Parameters:
        responseCode - HTTP response code to test
        Returns:
        A reference to this Builder instance

      • sourceId

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

      • validateProfileId

        public TestScript.Setup.Action.Assert.Builder validateProfileId​(Id validateProfileId)
        The ID of the Profile to validate against.
        Parameters:
        validateProfileId - Profile Id of validation profile reference
        Returns:
        A reference to this Builder instance

      • warningOnly

        public TestScript.Setup.Action.Assert.Builder warningOnly​(Boolean warningOnly)
        Whether or not the test execution will produce a warning only on error for this assert.

        This element is required.

        Parameters:
        warningOnly - Will this assert produce a warning only on error?
        Returns:
        A reference to this Builder instance