Class PreferenceSectionV1

java.lang.Object

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

All Implemented Interfaces:

AbstractMiddlewareOutputInterface, UserPreferencesOutputInterface, ToSchema

public class PreferenceSectionV1
extends Object
implements UserPreferencesOutputInterface, ToSchema

PreferenceSectionV1 in the user preferences API.

Constructor Summary

Constructors

Constructor	Description
PreferenceSectionV1()

Method Summary

Modifier and Type	Method	Description
List<PreferenceActionV1>	getActions()	Get actions.
String	getAppName()	Get appName.
String	getDescription()	Get description.
List<FieldMetaData>	getFields()	Get fields.
Icon	getIcon()	Get icon.
String	getLabel()	Get label.
List<PreferenceListV1>	getLists()	Get lists.
String	getName()	Get name.
int	getOrder()	Get order.
Map<String,List<PossibleValueOption>>	getPossibleValues()	Get possibleValues.
boolean	getShowInUserMenu()	Get showInUserMenu.
Map<String,Serializable>	getValues()	Get values.
void	setActions(List<PreferenceActionV1> actions)	Set actions.
void	setAppName(String appName)	Set appName.
void	setDescription(String description)	Set description.
void	setFields(List<FieldMetaData> fields)	Set fields.
void	setIcon(Icon icon)	Set icon.
void	setLabel(String label)	Set label.
void	setLists(List<PreferenceListV1> lists)	Set lists.
void	setName(String name)	Set name.
void	setOrder(int order)	Set order.
void	setPossibleValues(Map<String,List<PossibleValueOption>> possibleValues)	Set possibleValues.
void	setPreferenceResults(List<UserPreferenceSectionResult> results)	Map core metadata and values, including ENUM choices for scalar and row fields.
void	setShowInUserMenu(boolean showInUserMenu)	Set showInUserMenu.
void	setValues(Map<String,Serializable> values)	Set values.
Schema	toSchema()	One visible section with the signed-in user's current preferences.
PreferenceSectionV1	withActions(List<PreferenceActionV1> actions)	With actions.
PreferenceSectionV1	withAppName(String appName)	With appName.
PreferenceSectionV1	withDescription(String description)	With description.
PreferenceSectionV1	withFields(List<FieldMetaData> fields)	With fields.
PreferenceSectionV1	withIcon(Icon icon)	With icon.
PreferenceSectionV1	withLabel(String label)	With label.
PreferenceSectionV1	withLists(List<PreferenceListV1> lists)	With lists.
PreferenceSectionV1	withName(String name)	With name.
PreferenceSectionV1	withOrder(int order)	With order.
PreferenceSectionV1	withPossibleValues(Map<String,List<PossibleValueOption>> possibleValues)	With possibleValues.
PreferenceSectionV1	withShowInUserMenu(boolean showInUserMenu)	With showInUserMenu.
PreferenceSectionV1	withValues(Map<String,Serializable> values)	With values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.kingsrook.qqq.middleware.javalin.executors.io.UserPreferencesOutputInterface

setActionResult

Constructor Details

PreferenceSectionV1

public PreferenceSectionV1()

Method Details

toSchema

public Schema toSchema()

One visible section with the signed-in user's current preferences.

Specified by:

toSchema in interface ToSchema

setPreferenceResults

public void setPreferenceResults(List<UserPreferenceSectionResult> results)

Map core metadata and values, including ENUM choices for scalar and row fields.

Specified by:

setPreferenceResults in interface UserPreferencesOutputInterface

getName

public String getName()

Get name.

setName

public void setName(String name)

Set name.

withName

public PreferenceSectionV1 withName(String name)

With name.

getLabel

public String getLabel()

Get label.

setLabel

public void setLabel(String label)

Set label.

withLabel

public PreferenceSectionV1 withLabel(String label)

With label.

getIcon

public Icon getIcon()

Get icon.

setIcon

public void setIcon(Icon icon)

Set icon.

withIcon

public PreferenceSectionV1 withIcon(Icon icon)

With icon.

getDescription

public String getDescription()

Get description.

setDescription

public void setDescription(String description)

Set description.

withDescription

public PreferenceSectionV1 withDescription(String description)

With description.

getOrder

public int getOrder()

Get order.

setOrder

public void setOrder(int order)

Set order.

withOrder

public PreferenceSectionV1 withOrder(int order)

With order.

getAppName

public String getAppName()

Get appName.

setAppName

public void setAppName(String appName)

Set appName.

withAppName

public PreferenceSectionV1 withAppName(String appName)

With appName.

getFields

public List<FieldMetaData> getFields()

Get fields.

setFields

public void setFields(List<FieldMetaData> fields)

Set fields.

withFields

public PreferenceSectionV1 withFields(List<FieldMetaData> fields)

With fields.

getValues

public Map<String,Serializable> getValues()

Get values.

setValues

public void setValues(Map<String,Serializable> values)

Set values.

withValues

public PreferenceSectionV1 withValues(Map<String,Serializable> values)

With values.

getLists

public List<PreferenceListV1> getLists()

Get lists.

setLists

public void setLists(List<PreferenceListV1> lists)

Set lists.

withLists

public PreferenceSectionV1 withLists(List<PreferenceListV1> lists)

With lists.

getPossibleValues

public Map<String,List<PossibleValueOption>> getPossibleValues()

Get possibleValues.

setPossibleValues

public void setPossibleValues(Map<String,List<PossibleValueOption>> possibleValues)

Set possibleValues.

withPossibleValues

public PreferenceSectionV1 withPossibleValues(Map<String,List<PossibleValueOption>> possibleValues)

With possibleValues.

getActions

public List<PreferenceActionV1> getActions()

Get actions.

setActions

public void setActions(List<PreferenceActionV1> actions)

Set actions.

withActions

public PreferenceSectionV1 withActions(List<PreferenceActionV1> actions)

With actions.

getShowInUserMenu

public boolean getShowInUserMenu()

Get showInUserMenu.

setShowInUserMenu

public void setShowInUserMenu(boolean showInUserMenu)

Set showInUserMenu.

withShowInUserMenu

public PreferenceSectionV1 withShowInUserMenu(boolean showInUserMenu)

With showInUserMenu.