Class TableQuerySpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

com.kingsrook.qqq.middleware.javalin.specs.v1.TableQuerySpecV1

Direct Known Subclasses:

ApiAwareTableQuerySpecV1

public class TableQuerySpecV1
extends AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

qInstance

Constructor Summary

Constructors

Constructor	Description
TableQuerySpecV1()

Method Summary

Modifier and Type	Method	Description
TableQueryInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, TableQueryResponseV1 tableQueryResponseV1)	build the endpoint's http response (written to the javalin context) from an execution output object

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineResponses, defineRoute, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, isSecured, newExecutor, newOutput, serveRequest, setQInstance

Methods inherited from class java.lang.Object

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

Constructor Details

TableQuerySpecV1

public TableQuerySpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

buildInput

public TableQueryInput buildInput(io.javalin.http.Context context)
                           throws Exception

Description copied from class: AbstractEndpointSpec

build the endpoint's input object from a javalin context

Specified by:

buildInput in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 TableQueryResponseV1 tableQueryResponseV1)
                  throws Exception

Description copied from class: AbstractEndpointSpec

build the endpoint's http response (written to the javalin context) from an execution output object

Overrides:

handleOutput in class AbstractEndpointSpec<TableQueryInput,TableQueryResponseV1,TableQueryExecutor>

Throws:

Exception