Package org.linuxforhealth.fhir.model.resource

Class TestScript.Setup.Action.Operation.Builder

    • Method Detail

      • id

        public TestScript.Setup.Action.Operation.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.Operation.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.Operation.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.Operation.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.Operation.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.Operation.Builder label​(String label)
        The label would be used for tracking/logging purposes by test engines.
        Parameters:
        label - Tracking/logging operation label
        Returns:
        A reference to this Builder instance

      • description

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

      • accept

        public TestScript.Setup.Action.Operation.Builder accept​(Code accept)
        The mime-type to use for RESTful operation in the 'Accept' header.
        Parameters:
        accept - Mime type to accept in the payload of the response, with charset etc.
        Returns:
        A reference to this Builder instance

      • contentType

        public TestScript.Setup.Action.Operation.Builder contentType​(Code contentType)
        The mime-type to use for RESTful operation in the 'Content-Type' header.
        Parameters:
        contentType - Mime type of the request payload contents, with charset etc.
        Returns:
        A reference to this Builder instance

      • destination

        public TestScript.Setup.Action.Operation.Builder destination​(Integer destination)
        The server where the request message is destined for. Must be one of the server numbers listed in TestScript. destination section.
        Parameters:
        destination - Server responding to the request
        Returns:
        A reference to this Builder instance

      • encodeRequestUrl

        public TestScript.Setup.Action.Operation.Builder encodeRequestUrl​(Boolean encodeRequestUrl)
        Whether or not to implicitly send the request url in encoded format. The default is true to match the standard RESTful client behavior. Set to false when communicating with a server that does not support encoded url paths.

        This element is required.

        Parameters:
        encodeRequestUrl - Whether or not to send the request url in encoded format
        Returns:
        A reference to this Builder instance

      • origin

        public TestScript.Setup.Action.Operation.Builder origin​(Integer origin)
        The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.
        Parameters:
        origin - Server initiating the request
        Returns:
        A reference to this Builder instance

      • params

        public TestScript.Setup.Action.Operation.Builder params​(String params)
        Path plus parameters after [type]. Used to set parts of the request URL explicitly.
        Parameters:
        params - Explicitly defined path parameters
        Returns:
        A reference to this Builder instance

      • requestHeader

        public TestScript.Setup.Action.Operation.Builder requestHeader​(java.util.Collection<TestScript.Setup.Action.Operation.RequestHeader> requestHeader)
        Header elements would be used to set HTTP 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:
        requestHeader - Each operation can have one or more header elements
        Returns:
        A reference to this Builder instance
        Throws:
        java.lang.NullPointerException - If the passed collection is null

      • requestId

        public TestScript.Setup.Action.Operation.Builder requestId​(Id requestId)
        The fixture id (maybe new) to map to the request.
        Parameters:
        requestId - Fixture Id of mapped request
        Returns:
        A reference to this Builder instance

      • responseId

        public TestScript.Setup.Action.Operation.Builder responseId​(Id responseId)
        The fixture id (maybe new) to map to the response.
        Parameters:
        responseId - Fixture Id of mapped response
        Returns:
        A reference to this Builder instance

      • sourceId

        public TestScript.Setup.Action.Operation.Builder sourceId​(Id sourceId)
        The id of the fixture used as the body of a PUT or POST request.
        Parameters:
        sourceId - Fixture Id of body for PUT and POST requests
        Returns:
        A reference to this Builder instance

      • targetId

        public TestScript.Setup.Action.Operation.Builder targetId​(Id targetId)
        Id of fixture used for extracting the [id], [type], and [vid] for GET requests.
        Parameters:
        targetId - Id of fixture used for extracting the [id], [type], and [vid] for GET requests
        Returns:
        A reference to this Builder instance