org.cornutum.tcases.openapi.resolver

Class RequestCaseDef

java.lang.Object

org.cornutum.tcases.openapi.resolver.RequestCaseDef

public class RequestCaseDef
extends Object

Describes an abstract test case for an API request.

Constructor Summary

Constructors

Constructor and Description
RequestCaseDef(int id) Creates a new RequestCaseDef instance.

Method Summary

Modifier and Type	Method and Description
void	addParam(ParamDef param) Adds a parameter definition for this request.
ValueDef<?>	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<ParamDef>	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.
boolean	isFailure() Returns true for a request with an invalid input.
void	setBody(ValueDef<?> 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<ParamDef> params) Changes the parameter definitions for this request.
void	setPath(String path) Changes the path 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestCaseDef

public RequestCaseDef(int id)

Creates a new RequestCaseDef 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.

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<ParamDef> params)

Changes the parameter definitions for this request.

getParams

public Iterable<ParamDef> getParams()

Returns the parameter definitions for this request.

addParam

public void addParam(ParamDef param)

Adds a parameter definition for this request.

setBody

public void setBody(ValueDef<?> body)

Changes the definition of the request body.

getBody

public ValueDef<?> 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.

toString

public String toString()

Overrides:

toString in class Object