Class PreferenceSectionGetSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

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

public class PreferenceSectionGetSpecV1
extends AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

Read one visible section for the signed-in user.

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
PreferenceSectionGetSpecV1()

Method Summary

Modifier and Type	Method	Description
UserPreferencesMiddlewareInput	buildInput(io.javalin.http.Context context)	Build the typed operation input.
BasicOperation	defineBasicOperation()	Read one visible section for the signed-in user
BasicResponse	defineBasicSuccessResponse()	The typed success response.
Map<String,Schema>	defineComponentSchemas()	Publish all preference component schemas.
List<Parameter>	defineRequestParameters()	Path parameters; userId query parameters are never read.
void	handleOutput(io.javalin.http.Context context, PreferenceSectionV1 output)	Serialize null preferences explicitly so clients can distinguish cleared values.

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

PreferenceSectionGetSpecV1

public PreferenceSectionGetSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Read one visible section for the signed-in user

Overrides:

defineBasicOperation in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Path parameters; userId query parameters are never read.

Overrides:

defineRequestParameters in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

buildInput

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

Build the typed operation input.

Specified by:

buildInput in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Publish all preference component schemas.

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

The typed success response.

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>

handleOutput

public void handleOutput(io.javalin.http.Context context,
 PreferenceSectionV1 output)

Serialize null preferences explicitly so clients can distinguish cleared values.

Overrides:

handleOutput in class AbstractEndpointSpec<UserPreferencesMiddlewareInput,PreferenceSectionV1,UserPreferencesExecutor>