Class QAppMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.layout.QAppMetaData

All Implemented Interfaces:

QAppChildMetaData, MetaDataProducerOutput, MetaDataWithName, MetaDataWithPermissionRules, QMetaDataObject, TopLevelMetaDataInterface, Serializable

public class QAppMetaData
extends Object
implements QAppChildMetaData, MetaDataWithPermissionRules, TopLevelMetaDataInterface

MetaData definition of an App - an entity that organizes tables invalid input: '&' processes and can be arranged hierarchically (e.g, apps can contain other apps).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Integer	DEFAULT_SORT_ORDER
protected Map<String,List<QHelpContent>>	helpContent

Constructor Summary

Constructors

Constructor	Description
QAppMetaData()

Method Summary

Modifier and Type	Method	Description
void	addChild(QAppChildMetaData child)	Add a child to this app.
void	addSection(QAppSection section)
void	addSelfToInstance(QInstance qInstance)	call the appropriate methods on a QInstance to add ourselves to it.
Integer	getChildAppAffinity(String childName)	get the appAffinity assigned to this child (by name) for this app - null if not set.
List<QAppChildMetaData>	getChildren()	Getter for children
Map<String,List<QHelpContent>>	getHelpContent()	Getter for helpContent
QIcon	getIcon()	Getter for icon
String	getLabel()	Getter for label
String	getName()	Getter for name
String	getParentAppName()	Getter for parentAppName
QPermissionRules	getPermissionRules()	Getter for permissionRules
List<QAppSection>	getSections()	Getter for sections
Integer	getSortOrder()	Getter for sortOrder
Map<String,QSupplementalAppMetaData>	getSupplementalMetaData()	Getter for supplementalMetaData
List<String>	getWidgets()	Getter for widgets
void	removeHelpContent(String slot, Set<HelpRole> roles)	remove a helpContent for a slot based on its set of roles
void	setChildAppAffinity(String childName, Integer appAffinity)	set an appAffinity for a child.
void	setChildren(List<QAppChildMetaData> children)	Setter for children
void	setHelpContent(Map<String,List<QHelpContent>> helpContent)	Setter for helpContent
void	setIcon(QIcon icon)	Setter for icon
void	setLabel(String label)	Setter for label
void	setName(String name)	Setter for name
void	setParentAppName(String parentAppName)	Setter for parentAppName
void	setPermissionRules(QPermissionRules permissionRules)	Setter for permissionRules
void	setSections(List<QAppSection> sections)	Setter for sections
void	setSortOrder(Integer sortOrder)	Setter for sortOrder
void	setSupplementalMetaData(Map<String,QSupplementalAppMetaData> supplementalMetaData)	Setter for supplementalMetaData
void	setWidgets(List<String> widgets)	Setter for widgets
QAppMetaData	withChild(QAppChildMetaData child)	Fluently add a child to this app.
QAppMetaData	withChildren(List<QAppChildMetaData> children)	Fluent setter for children
QAppMetaData	withHelpContent(String slot, QHelpContent helpContent)	Fluent setter for adding 1 helpContent (for a slot)
QAppMetaData	withHelpContent(Map<String,List<QHelpContent>> helpContent)	Fluent setter for helpContent
QAppMetaData	withIcon(QIcon icon)	Fluent setter for icon
QAppMetaData	withLabel(String label)	Fluent setter for label
QAppMetaData	withName(String name)	Fluent setter for name
QAppMetaData	withPermissionRules(QPermissionRules permissionRules)	Fluent setter for permissionRules
QAppMetaData	withSection(QAppSection section)	Fluent setter for sections
QAppMetaData	withSectionOfChildren(QAppSection section, QAppChildMetaData... children)
QAppMetaData	withSectionOfChildren(QAppSection section, Collection<? extends QAppChildMetaData> children)
QAppMetaData	withSections(List<QAppSection> sections)	Fluent setter for sections
QAppMetaData	withSortOrder(Integer sortOrder)	Fluent setter for sortOrder
QAppMetaData	withSupplementalMetaData(QSupplementalAppMetaData supplementalMetaData)	Fluent setter for supplementalMetaData
QAppMetaData	withSupplementalMetaData(Map<String,QSupplementalAppMetaData> supplementalMetaData)	Fluent setter for supplementalMetaData
QAppMetaData	withWidgets(List<String> widgets)	Fluent setter for widgets

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SORT_ORDER

public static final Integer DEFAULT_SORT_ORDER

helpContent

protected Map<String,List<QHelpContent>> helpContent

Constructor Details

QAppMetaData

public QAppMetaData()

Method Details

getName

public String getName()

Getter for name

Specified by:

getName in interface MetaDataWithName

Specified by:

getName in interface QAppChildMetaData

Specified by:

getName in interface TopLevelMetaDataInterface

setName

public void setName(String name)

Setter for name

Specified by:

setName in interface MetaDataWithName

withName

public QAppMetaData withName(String name)

Fluent setter for name

getLabel

public String getLabel()

Getter for label

Specified by:

getLabel in interface MetaDataWithName

Specified by:

getLabel in interface QAppChildMetaData

setLabel

public void setLabel(String label)

Setter for label

Specified by:

setLabel in interface MetaDataWithName

withLabel

public QAppMetaData withLabel(String label)

Fluent setter for label

getChildren

public List<QAppChildMetaData> getChildren()

Getter for children

setChildren

public void setChildren(List<QAppChildMetaData> children)

Setter for children

addChild

public void addChild(QAppChildMetaData child)

Add a child to this app.

withChild

public QAppMetaData withChild(QAppChildMetaData child)

Fluently add a child to this app.

withChildren

public QAppMetaData withChildren(List<QAppChildMetaData> children)

Fluent setter for children

getParentAppName

public String getParentAppName()

Getter for parentAppName

setParentAppName

public void setParentAppName(String parentAppName)

Setter for parentAppName

getIcon

public QIcon getIcon()

Getter for icon

Specified by:

getIcon in interface QAppChildMetaData

setIcon

public void setIcon(QIcon icon)

Setter for icon

withIcon

public QAppMetaData withIcon(QIcon icon)

Fluent setter for icon

getWidgets

public List<String> getWidgets()

Getter for widgets

setWidgets

public void setWidgets(List<String> widgets)

Setter for widgets

withWidgets

public QAppMetaData withWidgets(List<String> widgets)

Fluent setter for widgets

getSections

public List<QAppSection> getSections()

Getter for sections

setSections

public void setSections(List<QAppSection> sections)

Setter for sections

withSections

public QAppMetaData withSections(List<QAppSection> sections)

Fluent setter for sections

addSection

public void addSection(QAppSection section)

withSection

public QAppMetaData withSection(QAppSection section)

Fluent setter for sections

withSectionOfChildren

public QAppMetaData withSectionOfChildren(QAppSection section,
 Collection<? extends QAppChildMetaData> children)

withSectionOfChildren

public QAppMetaData withSectionOfChildren(QAppSection section,
 QAppChildMetaData... children)

getPermissionRules

public QPermissionRules getPermissionRules()

Getter for permissionRules

Specified by:

getPermissionRules in interface MetaDataWithPermissionRules

setPermissionRules

public void setPermissionRules(QPermissionRules permissionRules)

Setter for permissionRules

Specified by:

setPermissionRules in interface MetaDataWithPermissionRules

withPermissionRules

public QAppMetaData withPermissionRules(QPermissionRules permissionRules)

Fluent setter for permissionRules

addSelfToInstance

public void addSelfToInstance(QInstance qInstance)

Description copied from interface: MetaDataProducerOutput

call the appropriate methods on a QInstance to add ourselves to it.

Specified by:

addSelfToInstance in interface MetaDataProducerOutput

Specified by:

addSelfToInstance in interface TopLevelMetaDataInterface

getSortOrder

public Integer getSortOrder()

Getter for sortOrder

setSortOrder

public void setSortOrder(Integer sortOrder)

Setter for sortOrder

withSortOrder

public QAppMetaData withSortOrder(Integer sortOrder)

Fluent setter for sortOrder

getSupplementalMetaData

public Map<String,QSupplementalAppMetaData> getSupplementalMetaData()

Getter for supplementalMetaData

setSupplementalMetaData

public void setSupplementalMetaData(Map<String,QSupplementalAppMetaData> supplementalMetaData)

Setter for supplementalMetaData

withSupplementalMetaData

public QAppMetaData withSupplementalMetaData(QSupplementalAppMetaData supplementalMetaData)

Fluent setter for supplementalMetaData

withSupplementalMetaData

public QAppMetaData withSupplementalMetaData(Map<String,QSupplementalAppMetaData> supplementalMetaData)

Fluent setter for supplementalMetaData

setChildAppAffinity

public void setChildAppAffinity(String childName,
 Integer appAffinity)

set an appAffinity for a child. Higher values are higher affinity, with null (the default) considered the lowest. Tiebreaking behavior is not specified and may differ by use-case (e.g., by front-end), though app sort-order is recommended.

The purpose of this appAffinity is not about ordering the children of this app - but rather - for cases where the same object (e.g. a table) is referenced by multiple apps, and we want to control which app should be displayed first when the object is referenced.

Parameters:

childName - name of child (e.g., a table name) to set appAffinity for

appAffinity - appAffinity level, or null to clear any existing appAffinity. Higher values are higher affinity. null is lowest.

getChildAppAffinity

public Integer getChildAppAffinity(String childName)

get the appAffinity assigned to this child (by name) for this app - null if not set.

Parameters:

childName - name of child (e.g., a table name) to get appAffinity for

Returns:

appAffinity level, or null if not set.

getHelpContent

public Map<String,List<QHelpContent>> getHelpContent()

Getter for helpContent

setHelpContent

public void setHelpContent(Map<String,List<QHelpContent>> helpContent)

Setter for helpContent

withHelpContent

public QAppMetaData withHelpContent(Map<String,List<QHelpContent>> helpContent)

Fluent setter for helpContent

withHelpContent

public QAppMetaData withHelpContent(String slot,
 QHelpContent helpContent)

Fluent setter for adding 1 helpContent (for a slot)

removeHelpContent

public void removeHelpContent(String slot,
 Set<HelpRole> roles)

remove a helpContent for a slot based on its set of roles