Class ApiProcessObjectOutput

java.lang.Object

com.kingsrook.qqq.api.model.metadata.processes.ApiProcessObjectOutput

All Implemented Interfaces:

ApiProcessOutputInterface

public class ApiProcessObjectOutput
extends Object
implements ApiProcessOutputInterface

Constructor Summary

Constructors

Constructor	Description
ApiProcessObjectOutput()

Method Summary

Modifier and Type	Method	Description
List<QFieldMetaData>	getOutputFields()	Getter for outputFields
Serializable	getOutputForProcess(RunProcessInput runProcessInput, RunProcessOutput runProcessOutput)
String	getResponseDescription()	Getter for responseDescription
Map<Integer,Response>	getSpecResponses(String apiName)
org.eclipse.jetty.http.HttpStatus.Code	getSuccessResponseCode()	Getter for successResponseCode
org.eclipse.jetty.http.HttpStatus.Code	getSuccessStatusCode(RunProcessInput runProcessInput, RunProcessOutput runProcessOutput)
void	setOutputFields(List<QFieldMetaData> outputFields)	Setter for outputFields
void	setResponseDescription(String responseDescription)	Setter for responseDescription
void	setSuccessResponseCode(org.eclipse.jetty.http.HttpStatus.Code successResponseCode)	Setter for successResponseCode
ApiProcessObjectOutput	withOutputField(QFieldMetaData outputField)	Fluent setter for a single outputField
ApiProcessObjectOutput	withOutputFields(List<QFieldMetaData> outputFields)	Fluent setter for outputFields
ApiProcessObjectOutput	withResponseDescription(String responseDescription)	Fluent setter for responseDescription
ApiProcessObjectOutput	withSuccessResponseCode(org.eclipse.jetty.http.HttpStatus.Code successResponseCode)	Fluent setter for successResponseCode

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.kingsrook.qqq.api.model.metadata.processes.ApiProcessOutputInterface

customizeHttpApiResponse

Constructor Details

ApiProcessObjectOutput

public ApiProcessObjectOutput()

Method Details

getSuccessStatusCode

public org.eclipse.jetty.http.HttpStatus.Code getSuccessStatusCode(RunProcessInput runProcessInput,
 RunProcessOutput runProcessOutput)

Specified by:

getSuccessStatusCode in interface ApiProcessOutputInterface

getSpecResponses

public Map<Integer,Response> getSpecResponses(String apiName)

Specified by:

getSpecResponses in interface ApiProcessOutputInterface

getOutputForProcess

public Serializable getOutputForProcess(RunProcessInput runProcessInput,
 RunProcessOutput runProcessOutput)

Specified by:

getOutputForProcess in interface ApiProcessOutputInterface

getOutputFields

public List<QFieldMetaData> getOutputFields()

Getter for outputFields

setOutputFields

public void setOutputFields(List<QFieldMetaData> outputFields)

Setter for outputFields

withOutputFields

public ApiProcessObjectOutput withOutputFields(List<QFieldMetaData> outputFields)

Fluent setter for outputFields

withOutputField

public ApiProcessObjectOutput withOutputField(QFieldMetaData outputField)

Fluent setter for a single outputField

getResponseDescription

public String getResponseDescription()

Getter for responseDescription

setResponseDescription

public void setResponseDescription(String responseDescription)

Setter for responseDescription

withResponseDescription

public ApiProcessObjectOutput withResponseDescription(String responseDescription)

Fluent setter for responseDescription

getSuccessResponseCode

public org.eclipse.jetty.http.HttpStatus.Code getSuccessResponseCode()

Getter for successResponseCode

setSuccessResponseCode

public void setSuccessResponseCode(org.eclipse.jetty.http.HttpStatus.Code successResponseCode)

Setter for successResponseCode

withSuccessResponseCode

public ApiProcessObjectOutput withSuccessResponseCode(org.eclipse.jetty.http.HttpStatus.Code successResponseCode)

Fluent setter for successResponseCode