Class ProcessCancelSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

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

public class ProcessCancelSpecV1
extends AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

Endpoint spec for cancelling a running process.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
ProcessCancelSpecV1()

Method Summary

Modifier and Type	Method	Description
ProcessCancelInput	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, ProcessCancelResponseV1 output)	Override handleOutput to return a simple empty JSON object.

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

ProcessCancelSpecV1

public ProcessCancelSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

buildInput

public ProcessCancelInput 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<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

handleOutput

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

Override handleOutput to return a simple empty JSON object.

Overrides:

handleOutput in class AbstractEndpointSpec<ProcessCancelInput,ProcessCancelResponseV1,ProcessCancelExecutor>

Throws:

Exception