Class ProcessRecordsSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

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

public class ProcessRecordsSpecV1
extends AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

Endpoint spec for fetching records from a process state.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
ProcessRecordsSpecV1()

Method Summary

Modifier and Type	Method	Description
ProcessRecordsInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()
void	handleOutput(io.javalin.http.Context context, ProcessRecordsResponseV1 output)	Override handleOutput to ensure Include.ALWAYS on empty records list, following the same pattern as TableQuerySpecV1.

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, 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

ProcessRecordsSpecV1

public ProcessRecordsSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

buildInput

public ProcessRecordsInput 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<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 ProcessRecordsResponseV1 output)
                  throws Exception

Override handleOutput to ensure Include.ALWAYS on empty records list, following the same pattern as TableQuerySpecV1.

Overrides:

handleOutput in class AbstractEndpointSpec<ProcessRecordsInput,ProcessRecordsResponseV1,ProcessRecordsExecutor>

Throws:

Exception