Class AuditsMetaDataProvider

java.lang.Object

com.kingsrook.qqq.backend.core.model.audits.AuditsMetaDataProvider

public class AuditsMetaDataProvider
extends Object

MetaData provider for the QQQ audit system tables. By default, the audit table's recordId field is INTEGER, which supports auditing tables with integer primary keys. To audit tables with String or UUID primary keys, configure the provider with a STRING recordId type:

 new AuditsMetaDataProvider()
    .withRecordIdType(QFieldType.STRING)
    .defineAll(qInstance, backendName, enricher);
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TABLE_NAME_AUDIT
static final String	TABLE_NAME_AUDIT_DETAIL
static final String	TABLE_NAME_AUDIT_TABLE
static final String	TABLE_NAME_AUDIT_USER

Constructor Summary

Constructors

Constructor	Description
AuditsMetaDataProvider()

Method Summary

Modifier and Type	Method	Description
void	defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher)
void	defineStandardAuditPossibleValueSources(QInstance instance)
void	defineStandardAuditTables(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher)
QFieldType	getRecordIdType()	Getter for recordIdType
void	setRecordIdType(QFieldType recordIdType)	Setter for recordIdType
AuditsMetaDataProvider	withRecordIdType(QFieldType recordIdType)	Fluent setter for recordIdType

Methods inherited from class java.lang.Object

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

Field Details

TABLE_NAME_AUDIT_TABLE

public static final String TABLE_NAME_AUDIT_TABLE

See Also:

• Constant Field Values

TABLE_NAME_AUDIT_USER

public static final String TABLE_NAME_AUDIT_USER

See Also:

• Constant Field Values

TABLE_NAME_AUDIT

public static final String TABLE_NAME_AUDIT

See Also:

• Constant Field Values

TABLE_NAME_AUDIT_DETAIL

public static final String TABLE_NAME_AUDIT_DETAIL

See Also:

• Constant Field Values

Constructor Details

AuditsMetaDataProvider

public AuditsMetaDataProvider()

Method Details

defineAll

public void defineAll(QInstance instance,
 String backendName,
 Consumer<QTableMetaData> backendDetailEnricher)
               throws QException

Throws:

QException

defineStandardAuditTables

public void defineStandardAuditTables(QInstance instance,
 String backendName,
 Consumer<QTableMetaData> backendDetailEnricher)
                               throws QException

Throws:

QException

defineStandardAuditPossibleValueSources

public void defineStandardAuditPossibleValueSources(QInstance instance)

getRecordIdType

public QFieldType getRecordIdType()

Getter for recordIdType

setRecordIdType

public void setRecordIdType(QFieldType recordIdType)

Setter for recordIdType

withRecordIdType

public AuditsMetaDataProvider withRecordIdType(QFieldType recordIdType)

Fluent setter for recordIdType