Class UserPreferencesMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.preferences.UserPreferencesMetaData

All Implemented Interfaces:

MetaDataProducerOutput, QMetaDataObject, QSupplementalInstanceMetaData, TopLevelMetaDataInterface, Serializable

public class UserPreferencesMetaData
extends Object
implements QSupplementalInstanceMetaData

Registry and startup validation of user preference sections.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_TABLE_NAME
static final String	NAME

Constructor Summary

Constructors

Constructor	Description
UserPreferencesMetaData()

Method Summary

Modifier and Type	Method	Description
String	getKeyValueTableName()	Get keyValueTableName.
String	getName()	Supplemental metadata registry name.
List<UserPreferenceSectionMetaData>	getSections()	Get sections.
static UserPreferencesMetaData	of(QInstance qInstance)	Get registered preferences, or null when none are installed.
static UserPreferencesMetaData	ofOrWithNew(QInstance qInstance)	Get or register preferences metadata.
void	setKeyValueTableName(String keyValueTableName)	Set keyValueTableName.
void	setSections(List<UserPreferenceSectionMetaData> sections)	Set sections.
void	validate(QInstance qInstance, QInstanceValidator validator)	Validate through QInstanceValidator's supplemental metadata hook.
UserPreferencesMetaData	withKeyValueTableName(String keyValueTableName)	With keyValueTableName.
UserPreferencesMetaData	withSection(UserPreferenceSectionMetaData section)	Add a section.
UserPreferencesMetaData	withSections(List<UserPreferenceSectionMetaData> sections)	With sections.

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.backend.core.model.metadata.QSupplementalInstanceMetaData

addSelfToInstance, enrich

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_TABLE_NAME

public static final String DEFAULT_TABLE_NAME

See Also:

• Constant Field Values

Constructor Details

UserPreferencesMetaData

public UserPreferencesMetaData()

Method Details

of

public static UserPreferencesMetaData of(QInstance qInstance)

Get registered preferences, or null when none are installed.

ofOrWithNew

public static UserPreferencesMetaData ofOrWithNew(QInstance qInstance)

Get or register preferences metadata.

getName

public String getName()

Supplemental metadata registry name.

Specified by:

getName in interface TopLevelMetaDataInterface

withSection

public UserPreferencesMetaData withSection(UserPreferenceSectionMetaData section)

Add a section.

getSections

public List<UserPreferenceSectionMetaData> getSections()

Get sections.

setSections

public void setSections(List<UserPreferenceSectionMetaData> sections)

Set sections.

withSections

public UserPreferencesMetaData withSections(List<UserPreferenceSectionMetaData> sections)

With sections.

getKeyValueTableName

public String getKeyValueTableName()

Get keyValueTableName.

setKeyValueTableName

public void setKeyValueTableName(String keyValueTableName)

Set keyValueTableName.

withKeyValueTableName

public UserPreferencesMetaData withKeyValueTableName(String keyValueTableName)

With keyValueTableName.

validate

public void validate(QInstance qInstance,
 QInstanceValidator validator)

Validate through QInstanceValidator's supplemental metadata hook.

Specified by:

validate in interface QSupplementalInstanceMetaData