Class AiFieldMetaData

java.lang.Object

com.kingsrook.qqq.backend.core.model.metadata.fields.QSupplementalFieldMetaData

com.kingsrook.qqq.backend.core.actions.ai.AiFieldMetaData

public class AiFieldMetaData
extends QSupplementalFieldMetaData

Supplemental field meta-data (type "ai") for the AI tool kernel: how much of the field is exposed to a model, and an optional description written for a model (aiDescription). A null exposure means "use the default": NONE for hidden fields, password (masked) fields and fields with a FieldSecurityLock, else the kernel settings' defaultExposure. An explicit exposure always wins over the default (so an app developer may deliberately expose e.g. a hidden field - though the kernel's actions still omit hidden fields and mask passwords). Either way, a field's exposure is capped by its table's exposure.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Constructor Summary

Constructors

Constructor	Description
AiFieldMetaData()

Method Summary

Modifier and Type	Method	Description
String	getAiDescription()	Getter for aiDescription
DataClassification	getClassification()	Getter for classification (null means not classified)
AiExposure	getExposure()	Getter for exposure
String	getType()	Getter for type
static AiFieldMetaData	of(QFieldMetaData field)	The AiFieldMetaData on a field, or null if it has none.
void	setAiDescription(String aiDescription)	Setter for aiDescription
void	setClassification(DataClassification classification)	Setter for classification
void	setExposure(AiExposure exposure)	Setter for exposure
AiFieldMetaData	withAiDescription(String aiDescription)	Fluent setter for aiDescription
AiFieldMetaData	withClassification(DataClassification classification)	Fluent setter for classification
AiFieldMetaData	withExposure(AiExposure exposure)	Fluent setter for exposure

Methods inherited from class com.kingsrook.qqq.backend.core.model.metadata.fields.QSupplementalFieldMetaData

enrich, includeInFrontendMetaData, validate

Methods inherited from class java.lang.Object

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

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

Constructor Details

AiFieldMetaData

public AiFieldMetaData()

Method Details

of

public static AiFieldMetaData of(QFieldMetaData field)

The AiFieldMetaData on a field, or null if it has none.

getType

public String getType()

Description copied from class: QSupplementalFieldMetaData

Getter for type

Specified by:

getType in class QSupplementalFieldMetaData

getExposure

public AiExposure getExposure()

Getter for exposure

setExposure

public void setExposure(AiExposure exposure)

Setter for exposure

withExposure

public AiFieldMetaData withExposure(AiExposure exposure)

Fluent setter for exposure

getAiDescription

public String getAiDescription()

Getter for aiDescription

setAiDescription

public void setAiDescription(String aiDescription)

Setter for aiDescription

withAiDescription

public AiFieldMetaData withAiDescription(String aiDescription)

Fluent setter for aiDescription

getClassification

public DataClassification getClassification()

Getter for classification (null means not classified)

setClassification

public void setClassification(DataClassification classification)

Setter for classification

withClassification

public AiFieldMetaData withClassification(DataClassification classification)

Fluent setter for classification