Class TableFormAdjusterSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

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

public class TableFormAdjusterSpecV1
extends AbstractJsonEndpointSpec

POST /table/{tableName}/formAdjuster/{identifier}/{event}: run a table form's adjuster (the table's on-load adjuster, identifier `table:{name}`, or a field's on-load / on-change adjuster, by its formAdjusterIdentifier). Adjusters are registered by the Material Dashboard module (FormAdjusterRegistry), which also adds the process that runs them (FORM_ADJUSTER_PROCESS_NAME). This spec runs that process in the caller's session (the legacy /material-dashboard-backend/form-adjuster route runs it unauthenticated, as the system user) after checking that the caller may insert or edit records in the table. Without the module there are no adjusters and the operation answers 404.

Nested Class Summary

Nested classes/interfaces inherited from class com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

AbstractJsonEndpointSpec.JsonExecutor, AbstractJsonEndpointSpec.JsonInput, AbstractJsonEndpointSpec.JsonOutput, AbstractJsonEndpointSpec.JsonOutputInterface

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EVENT_ON_CHANGE
static final String	EVENT_ON_LOAD
static final String	FORM_ADJUSTER_PROCESS_NAME	the process the Material Dashboard module registers to run adjusters

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

qInstance

Constructor Summary

Constructors

Constructor	Description
TableFormAdjusterSpecV1()

Method Summary

Modifier and Type	Method	Description
BasicOperation	defineBasicOperation()
Map<String,Schema>	defineComponentSchemas()
protected Schema	defineRequestBodySchema()	The schema of the JSON request body, or null (the default) for none.
List<Parameter>	defineRequestParameters()
protected String	getResponseSchemaName()	The component schema name of the 200 response body.
protected Object	handle(AbstractJsonEndpointSpec.JsonInput input)	Do the operation's work (the QContext has the session for a secured spec) and return the response body (serialized to JSON).

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.extensions.AbstractJsonEndpointSpec

buildInput, defineBasicSuccessResponse, defineRequestBody, handleOutput

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

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

Field Details

FORM_ADJUSTER_PROCESS_NAME

public static final String FORM_ADJUSTER_PROCESS_NAME

the process the Material Dashboard module registers to run adjusters

See Also:

• Constant Field Values

EVENT_ON_LOAD

public static final String EVENT_ON_LOAD

See Also:

• Constant Field Values

EVENT_ON_CHANGE

public static final String EVENT_ON_CHANGE

See Also:

• Constant Field Values

Constructor Details

TableFormAdjusterSpecV1

public TableFormAdjusterSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

defineRequestBodySchema

protected Schema defineRequestBodySchema()

Description copied from class: AbstractJsonEndpointSpec

The schema of the JSON request body, or null (the default) for none.

Overrides:

defineRequestBodySchema in class AbstractJsonEndpointSpec

getResponseSchemaName

protected String getResponseSchemaName()

Description copied from class: AbstractJsonEndpointSpec

The component schema name of the 200 response body.

Specified by:

getResponseSchemaName in class AbstractJsonEndpointSpec

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<AbstractJsonEndpointSpec.JsonInput,AbstractJsonEndpointSpec.JsonOutput,AbstractJsonEndpointSpec.JsonExecutor>

handle

protected Object handle(AbstractJsonEndpointSpec.JsonInput input)
                 throws Exception

Description copied from class: AbstractJsonEndpointSpec

Do the operation's work (the QContext has the session for a secured spec) and return the response body (serialized to JSON).

Specified by:

handle in class AbstractJsonEndpointSpec

Throws:

Exception