Class PreferenceActionResponseV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.v1.responses.PreferenceActionResponseV1

All Implemented Interfaces:

AbstractMiddlewareOutputInterface, UserPreferencesOutputInterface, ToSchema

public class PreferenceActionResponseV1
extends Object
implements UserPreferencesOutputInterface, ToSchema

PreferenceActionResponseV1 in the user preferences API.

Constructor Summary

Constructors

Constructor	Description
PreferenceActionResponseV1()

Method Summary

Modifier and Type	Method	Description
String	getFocusRowKey()	Get focusRowKey.
String	getMessage()	Get message.
List<PreferenceSecretV1>	getSecrets()	Get secrets.
PreferenceSectionV1	getSection()	Get section.
void	setActionResult(UserPreferenceActionResult result)	Map transient secrets only into this action response.
void	setFocusRowKey(String focusRowKey)	Set focusRowKey.
void	setMessage(String message)	Set message.
void	setPreferenceResults(List<UserPreferenceSectionResult> results)	Map only the reloaded, non-secret section.
void	setSecrets(List<PreferenceSecretV1> secrets)	Set secrets.
void	setSection(PreferenceSectionV1 section)	Set section.
Schema	toSchema()	Describe the wire contract.
PreferenceActionResponseV1	withFocusRowKey(String focusRowKey)	With focusRowKey.
PreferenceActionResponseV1	withMessage(String message)	With message.
PreferenceActionResponseV1	withSecrets(List<PreferenceSecretV1> secrets)	With secrets.
PreferenceActionResponseV1	withSection(PreferenceSectionV1 section)	With section.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PreferenceActionResponseV1

public PreferenceActionResponseV1()

Method Details

toSchema

public Schema toSchema()

Describe the wire contract.

Specified by:

toSchema in interface ToSchema

setPreferenceResults

public void setPreferenceResults(List<UserPreferenceSectionResult> results)

Map only the reloaded, non-secret section.

Specified by:

setPreferenceResults in interface UserPreferencesOutputInterface

setActionResult

public void setActionResult(UserPreferenceActionResult result)

Map transient secrets only into this action response.

Specified by:

setActionResult in interface UserPreferencesOutputInterface

getSection

public PreferenceSectionV1 getSection()

Get section.

setSection

public void setSection(PreferenceSectionV1 section)

Set section.

withSection

public PreferenceActionResponseV1 withSection(PreferenceSectionV1 section)

With section.

getMessage

public String getMessage()

Get message.

setMessage

public void setMessage(String message)

Set message.

withMessage

public PreferenceActionResponseV1 withMessage(String message)

With message.

getSecrets

public List<PreferenceSecretV1> getSecrets()

Get secrets.

setSecrets

public void setSecrets(List<PreferenceSecretV1> secrets)

Set secrets.

withSecrets

public PreferenceActionResponseV1 withSecrets(List<PreferenceSecretV1> secrets)

With secrets.

getFocusRowKey

public String getFocusRowKey()

Get focusRowKey.

setFocusRowKey

public void setFocusRowKey(String focusRowKey)

Set focusRowKey.

withFocusRowKey

public PreferenceActionResponseV1 withFocusRowKey(String focusRowKey)

With focusRowKey.