Class SavedViewsMetaDataProvider

java.lang.Object

com.kingsrook.qqq.backend.core.model.savedviews.SavedViewsMetaDataProvider

public class SavedViewsMetaDataProvider
extends Object

Define MetaData for the Saved Views functionality.

Optionally, sharing can be enabled (so a view created by one user can be seen by other users (and or groups, etc, as defined by app-level customizations). Similarly, an alternative presentation of some views as "Quick Saved Views" can be enabled (e.g., show quick ones as one-tap buttons, vs. the rest in a dropdown menu).

An optional RecordSecurityLock is encouraged to be provided, to apply to all the produced tables. Applications may add additional fields to these tables for custom security locks (in which case, they will need to put their own RecordSecurityLock on the table)s.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	QUICK_SAVED_VIEW_JOIN_SAVED_VIEW
static final String	SHARED_SAVED_VIEW_JOIN_SAVED_VIEW

Constructor Summary

Constructors

Constructor	Description
SavedViewsMetaDataProvider()

Method Summary

Modifier and Type	Method	Description
void	defineAll(QInstance instance, String backendName, Consumer<QTableMetaData> backendDetailEnricher)
QTableMetaData	defineSavedViewTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher)
QTableMetaData	defineSharedSavedViewTable(String backendName, Consumer<QTableMetaData> backendDetailEnricher)
boolean	getIsQuickSavedViewEnabled()	Getter for isQuickSavedViewEnabled
boolean	getIsShareSavedViewEnabled()	Getter for isShareSavedViewEnabled
RecordSecurityLock	getUserLevelRecordSecurityLock()	Getter for userLevelRecordSecurityLock
void	setIsQuickSavedViewEnabled(boolean isQuickSavedViewEnabled)	Setter for isQuickSavedViewEnabled
void	setIsShareSavedViewEnabled(boolean isShareSavedViewEnabled)	Setter for isShareSavedViewEnabled
void	setUserLevelRecordSecurityLock(RecordSecurityLock userLevelRecordSecurityLock)	Setter for userLevelRecordSecurityLock
SavedViewsMetaDataProvider	withIsQuickSavedViewEnabled(boolean isQuickSavedViewEnabled)	Fluent setter for isQuickSavedViewEnabled
SavedViewsMetaDataProvider	withIsShareSavedViewEnabled(boolean isShareSavedViewEnabled)	Fluent setter for isShareSavedViewEnabled
SavedViewsMetaDataProvider	withUserLevelRecordSecurityLock(RecordSecurityLock userLevelRecordSecurityLock)	Fluent setter for userLevelRecordSecurityLock

Methods inherited from class java.lang.Object

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

Field Details

SHARED_SAVED_VIEW_JOIN_SAVED_VIEW

public static final String SHARED_SAVED_VIEW_JOIN_SAVED_VIEW

See Also:

• Constant Field Values

QUICK_SAVED_VIEW_JOIN_SAVED_VIEW

public static final String QUICK_SAVED_VIEW_JOIN_SAVED_VIEW

See Also:

• Constant Field Values

Constructor Details

SavedViewsMetaDataProvider

public SavedViewsMetaDataProvider()

Method Details

defineAll

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

Throws:

QException

defineSavedViewTable

public QTableMetaData defineSavedViewTable(String backendName,
 Consumer<QTableMetaData> backendDetailEnricher)
                                    throws QException

Throws:

QException

defineSharedSavedViewTable

public QTableMetaData defineSharedSavedViewTable(String backendName,
 Consumer<QTableMetaData> backendDetailEnricher)
                                          throws QException

Throws:

QException

getIsQuickSavedViewEnabled

public boolean getIsQuickSavedViewEnabled()

Getter for isQuickSavedViewEnabled

See Also:

• withIsQuickSavedViewEnabled(boolean)

setIsQuickSavedViewEnabled

public void setIsQuickSavedViewEnabled(boolean isQuickSavedViewEnabled)

Setter for isQuickSavedViewEnabled

See Also:

• withIsQuickSavedViewEnabled(boolean)

withIsQuickSavedViewEnabled

public SavedViewsMetaDataProvider withIsQuickSavedViewEnabled(boolean isQuickSavedViewEnabled)

Fluent setter for isQuickSavedViewEnabled

Parameters:

isQuickSavedViewEnabled - Controls if, when defineAll is called, whether to include Quick Saved Views in the metadata definition. default value is false

Returns:

this

getIsShareSavedViewEnabled

public boolean getIsShareSavedViewEnabled()

Getter for isShareSavedViewEnabled

See Also:

• withIsShareSavedViewEnabled(boolean)

setIsShareSavedViewEnabled

public void setIsShareSavedViewEnabled(boolean isShareSavedViewEnabled)

Setter for isShareSavedViewEnabled

See Also:

• withIsShareSavedViewEnabled(boolean)

withIsShareSavedViewEnabled

public SavedViewsMetaDataProvider withIsShareSavedViewEnabled(boolean isShareSavedViewEnabled)

Fluent setter for isShareSavedViewEnabled

Parameters:

isShareSavedViewEnabled - Controls if, when defineAll is called, whether to include Shared Saved Views in the metadata definition. default value is true.

Returns:

this

getUserLevelRecordSecurityLock

public RecordSecurityLock getUserLevelRecordSecurityLock()

Getter for userLevelRecordSecurityLock

See Also:

• withUserLevelRecordSecurityLock(RecordSecurityLock)

setUserLevelRecordSecurityLock

public void setUserLevelRecordSecurityLock(RecordSecurityLock userLevelRecordSecurityLock)

Setter for userLevelRecordSecurityLock

See Also:

• withUserLevelRecordSecurityLock(RecordSecurityLock)

withUserLevelRecordSecurityLock

public SavedViewsMetaDataProvider withUserLevelRecordSecurityLock(RecordSecurityLock userLevelRecordSecurityLock)

Fluent setter for userLevelRecordSecurityLock

Parameters:

userLevelRecordSecurityLock -

Returns:

this