RequestCase (Tcases OpenAPI 3.3.0 API)

java.lang.Object
- org.cornutum.tcases.openapi.resolver.RequestCase

All Implemented Interfaces:

Comparable<RequestCase>
```
public class RequestCase
extends Object
implements Comparable<RequestCase>
```
Describes an executable test case for an API request.

Constructor Summary

Constructors
Constructor and Description

RequestCase(int id)
Creates a new RequestCase instance.

Constructors
Constructor and Description
`RequestCase(int id)` Creates a new RequestCase instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParam(ParamData param)` Adds a parameter definition for this request.
`int`	`compareTo(RequestCase other)`
`boolean`	`equals(Object object)`
`MessageData`	`getBody()` Returns the definition of the request body.
`int`	`getId()` Returns the id number for this test case.
`String`	`getInvalidInput()` Returns the description of the invalid input for this request.
`String`	`getOperation()` Returns the operation for this request.
`Iterable<ParamData>`	`getParams()` Returns the parameter definitions for this request.
`String`	`getPath()` Returns the path for this request.
`URI`	`getServer()` Returns the server URI for this request.
`String`	`getVersion()` Returns the API version for this request.
`int`	`hashCode()`
`boolean`	`isFailure()` Returns true for a request with an invalid input.
`void`	`setBody(MessageData body)` Changes the definition of the request body.
`void`	`setInvalidInput(String invalidInput)` Changes the description of the invalid input for this request.
`void`	`setOperation(String operation)` Changes the operation for this request.
`void`	`setParams(Iterable<ParamData> params)` Changes the parameter definitions for this request.
`void`	`setPath(String path)` Changes the path for this request.
`void`	`setServer(String uri)` Changes the server URI for this request.
`void`	`setServer(URI uri)` Changes the server URI for this request.
`void`	`setVersion(String version)` Changes the API version for this request.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RequestCase
```
public RequestCase(int id)
```
    Creates a new RequestCase instance.
- Method Detail
  - getId
```
public int getId()
```
    Returns the id number for this test case.
  - setServer
```
public void setServer(URI uri)
```
    Changes the server URI for this request.
  - setServer
```
public void setServer(String uri)
```
    Changes the server URI for this request.
  - getServer
```
public URI getServer()
```
    Returns the server URI for this request.
  - setVersion
```
public void setVersion(String version)
```
    Changes the API version for this request.
  - getVersion
```
public String getVersion()
```
    Returns the API version for this request.
  - setPath
```
public void setPath(String path)
```
    Changes the path for this request.
  - getPath
```
public String getPath()
```
    Returns the path for this request.
  - setOperation
```
public void setOperation(String operation)
```
    Changes the operation for this request.
  - getOperation
```
public String getOperation()
```
    Returns the operation for this request.
  - setParams
```
public void setParams(Iterable<ParamData> params)
```
    Changes the parameter definitions for this request.
  - getParams
```
public Iterable<ParamData> getParams()
```
    Returns the parameter definitions for this request.
  - addParam
```
public void addParam(ParamData param)
```
    Adds a parameter definition for this request.
  - setBody
```
public void setBody(MessageData body)
```
    Changes the definition of the request body.
  - getBody
```
public MessageData getBody()
```
    Returns the definition of the request body.
  - setInvalidInput
```
public void setInvalidInput(String invalidInput)
```
    Changes the description of the invalid input for this request.
  - getInvalidInput
```
public String getInvalidInput()
```
    Returns the description of the invalid input for this request. Returns null for a valid request.
  - isFailure
```
public boolean isFailure()
```
    Returns true for a request with an invalid input.
  - compareTo
```
public int compareTo(RequestCase other)
```
    Specified by:
    
    compareTo in interface Comparable<RequestCase>
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RequestCase

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RequestCase

Method Detail

getId

setServer

setServer

getServer

setVersion

getVersion

setPath

getPath

setOperation

getOperation

setParams

getParams

addParam

setBody

getBody

setInvalidInput

getInvalidInput

isFailure

compareTo

equals

hashCode

toString