Class RecordSearchSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

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

public class RecordSearchSpecV1
extends AbstractEndpointSpec<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

POST /search - record search across the tables that declare search fields.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
RecordSearchSpecV1()

Method Summary

Modifier and Type	Method	Description
RecordSearchMiddlewareInput	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()
void	handleOutput(io.javalin.http.Context context, RecordSearchResponseV1 output)	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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestParameters, defineResponses, defineRoute, getOperationId, 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

RecordSearchSpecV1

public RecordSearchSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

buildInput

public RecordSearchMiddlewareInput 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<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 RecordSearchResponseV1 output)
                  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<RecordSearchMiddlewareInput,RecordSearchResponseV1,RecordSearchExecutor>

Throws:

Exception