Class QMenuItemBuiltIn

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.menus.items.QMenuItemBase

com.kingsrook.qqq.backend.core.model.metadata.menus.items.QMenuItemBuiltIn

All Implemented Interfaces:

QMenuItemInterface, QMetaDataObject, Serializable, Cloneable

public class QMenuItemBuiltIn
extends QMenuItemBase

Menu item that represents a built-in action provided by the QQQ framework.

Built-in menu items are standard actions that are implemented by the framework itself, such as CRUD operations (New, Copy, Edit, Delete), bulk operations, system functions (Developer Mode, Audit), and process lists.

These items are distinguished from custom menu items (like running processes or downloading files) in that their behavior is predefined by the framework and does not require additional configuration.

See Also:

• QMenuItemBuiltIn.DefaultOptions
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	QMenuItemBuiltIn.BuiltInOptionInterface	Interface marker for built-in option types.
static enum	QMenuItemBuiltIn.DefaultOptions	Enumeration of default built-in menu item options provided by QQQ.

Constructor Summary

Constructors

Constructor	Description
QMenuItemBuiltIn()	Default constructor.
QMenuItemBuiltIn(QMenuItemBuiltIn.BuiltInOptionInterface option)	Constructor that initializes the built-in option.

Method Summary

Modifier and Type	Method	Description
QMenuItemBuiltIn	clone()	Creates and returns a shallow copy of this built-in menu item.
String	getItemType()	Returns the item type identifier for built-in menu items.
QMenuItemBuiltIn.BuiltInOptionInterface	getOption()	Getter for option
Map<String,Serializable>	getValues()	Returns the values map containing the built-in option.
void	setOption(QMenuItemBuiltIn.BuiltInOptionInterface option)	Setter for option
void	validate(QInstanceValidator validator, QInstance qInstance, QMetaDataObject parentObject)	Validates that the built-in menu item has a valid option configured.
QMenuItemBuiltIn	withOption(QMenuItemBuiltIn.BuiltInOptionInterface option)	Fluent setter for option

Methods inherited from class com.kingsrook.qqq.backend.core.model.metadata.menus.items.QMenuItemBase

getIcon, getLabel, setIcon, setLabel, withIcon, withLabel

Methods inherited from class java.lang.Object

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

Constructor Details

QMenuItemBuiltIn

public QMenuItemBuiltIn()

Default constructor.

QMenuItemBuiltIn

public QMenuItemBuiltIn(QMenuItemBuiltIn.BuiltInOptionInterface option)

Constructor that initializes the built-in option.

Parameters:

option - the built-in option to use (e.g., DefaultOptions.NEW)

Method Details

getItemType

public String getItemType()

Returns the item type identifier for built-in menu items.

Returns:

always returns "BUILT_IN"

getValues

public Map<String,Serializable> getValues()

Returns the values map containing the built-in option.

The map contains a single entry with key "option" and the option value.

Returns:

a map containing the built-in option

validate

public void validate(QInstanceValidator validator,
 QInstance qInstance,
 QMetaDataObject parentObject)

Validates that the built-in menu item has a valid option configured.

Ensures that the option field is not null before the menu item can be used in a menu.

Parameters:

validator - the validator instance to use for reporting errors

qInstance - the QQQ instance being validated

parentObject - the parent metadata object containing this menu item

getOption

public QMenuItemBuiltIn.BuiltInOptionInterface getOption()

Getter for option

See Also:

• withOption(BuiltInOptionInterface)

setOption

public void setOption(QMenuItemBuiltIn.BuiltInOptionInterface option)

Setter for option

See Also:

• withOption(BuiltInOptionInterface)

withOption

public QMenuItemBuiltIn withOption(QMenuItemBuiltIn.BuiltInOptionInterface option)

Fluent setter for option

Parameters:

option - Which built-in item to use

Returns:

this

clone

public QMenuItemBuiltIn clone()

Creates and returns a shallow copy of this built-in menu item.

Specified by:

clone in interface QMenuItemInterface

Overrides:

clone in class QMenuItemBase

Returns:

a clone of this menu item