Class TestScript.Setup.Action.Operation
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.type.Element
-
- org.linuxforhealth.fhir.model.type.BackboneElement
-
- org.linuxforhealth.fhir.model.resource.TestScript.Setup.Action.Operation
-
- All Implemented Interfaces:
Visitable
- Enclosing class:
- TestScript.Setup.Action
public static class TestScript.Setup.Action.Operation extends BackboneElement
The operation to perform.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TestScript.Setup.Action.Operation.Builder
static class
TestScript.Setup.Action.Operation.RequestHeader
Header elements would be used to set HTTP headers.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
modifierExtension
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static TestScript.Setup.Action.Operation.Builder
builder()
boolean
equals(java.lang.Object obj)
Code
getAccept()
The mime-type to use for RESTful operation in the 'Accept' header.Code
getContentType()
The mime-type to use for RESTful operation in the 'Content-Type' header.String
getDescription()
The description would be used by test engines for tracking and reporting purposes.Integer
getDestination()
The server where the request message is destined for.Boolean
getEncodeRequestUrl()
Whether or not to implicitly send the request url in encoded format.String
getLabel()
The label would be used for tracking/logging purposes by test engines.TestScriptRequestMethodCode
getMethod()
The HTTP method the test engine MUST use for this operation regardless of any other operation details.Integer
getOrigin()
The server where the request message originates from.String
getParams()
Path plus parameters after [type].java.util.List<TestScript.Setup.Action.Operation.RequestHeader>
getRequestHeader()
Header elements would be used to set HTTP headers.Id
getRequestId()
The fixture id (maybe new) to map to the request.FHIRDefinedType
getResource()
The type of the resource.Id
getResponseId()
The fixture id (maybe new) to map to the response.Id
getSourceId()
The id of the fixture used as the body of a PUT or POST request.Id
getTargetId()
Id of fixture used for extracting the [id], [type], and [vid] for GET requests.Coding
getType()
Server interaction or operation type.String
getUrl()
Complete request URL.boolean
hasChildren()
int
hashCode()
TestScript.Setup.Action.Operation.Builder
toBuilder()
Create a new Builder from the contents of this Element-
Methods inherited from class org.linuxforhealth.fhir.model.type.BackboneElement
getModifierExtension
-
Methods inherited from class org.linuxforhealth.fhir.model.type.Element
as, getExtension, getId, hasValue, is
-
-
-
-
Method Detail
-
getType
public Coding getType()
Server interaction or operation type.- Returns:
- An immutable object of type
Coding
that may be null.
-
getResource
public FHIRDefinedType getResource()
The type of the resource. See http://build.fhir.org/resourcelist.html.- Returns:
- An immutable object of type
FHIRDefinedType
that may be null.
-
getLabel
public String getLabel()
The label would be used for tracking/logging purposes by test engines.- Returns:
- An immutable object of type
String
that may be null.
-
getDescription
public String getDescription()
The description would be used by test engines for tracking and reporting purposes.- Returns:
- An immutable object of type
String
that may be null.
-
getAccept
public Code getAccept()
The mime-type to use for RESTful operation in the 'Accept' header.- Returns:
- An immutable object of type
Code
that may be null.
-
getContentType
public Code getContentType()
The mime-type to use for RESTful operation in the 'Content-Type' header.- Returns:
- An immutable object of type
Code
that may be null.
-
getDestination
public Integer getDestination()
The server where the request message is destined for. Must be one of the server numbers listed in TestScript. destination section.- Returns:
- An immutable object of type
Integer
that may be null.
-
getEncodeRequestUrl
public Boolean getEncodeRequestUrl()
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.- Returns:
- An immutable object of type
Boolean
that is non-null.
-
getMethod
public TestScriptRequestMethodCode getMethod()
The HTTP method the test engine MUST use for this operation regardless of any other operation details.- Returns:
- An immutable object of type
TestScriptRequestMethodCode
that may be null.
-
getOrigin
public Integer getOrigin()
The server where the request message originates from. Must be one of the server numbers listed in TestScript.origin section.- Returns:
- An immutable object of type
Integer
that may be null.
-
getParams
public String getParams()
Path plus parameters after [type]. Used to set parts of the request URL explicitly.- Returns:
- An immutable object of type
String
that may be null.
-
getRequestHeader
public java.util.List<TestScript.Setup.Action.Operation.RequestHeader> getRequestHeader()
Header elements would be used to set HTTP headers.- Returns:
- An unmodifiable list containing immutable objects of type
TestScript.Setup.Action.Operation.RequestHeader
that may be empty.
-
getRequestId
public Id getRequestId()
The fixture id (maybe new) to map to the request.- Returns:
- An immutable object of type
Id
that may be null.
-
getResponseId
public Id getResponseId()
The fixture id (maybe new) to map to the response.- Returns:
- An immutable object of type
Id
that may be null.
-
getSourceId
public Id getSourceId()
The id of the fixture used as the body of a PUT or POST request.- Returns:
- An immutable object of type
Id
that may be null.
-
getTargetId
public Id getTargetId()
Id of fixture used for extracting the [id], [type], and [vid] for GET requests.- Returns:
- An immutable object of type
Id
that may be null.
-
getUrl
public String getUrl()
Complete request URL.- Returns:
- An immutable object of type
String
that may be null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classBackboneElement
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public TestScript.Setup.Action.Operation.Builder toBuilder()
Description copied from class:Element
Create a new Builder from the contents of this Element- Specified by:
toBuilder
in classBackboneElement
-
builder
public static TestScript.Setup.Action.Operation.Builder builder()
-
-