Interface TemplateDataViewDefaults
- All Superinterfaces:
com.inet.plugin.NamedExtension
- All Known Implementing Classes:
PersistenceTemplateDataViewDefaults
public interface TemplateDataViewDefaults
extends com.inet.plugin.NamedExtension
Interface for registering dynamic data views in the DynamicExtensionManager or ServerPluginManager
- Since:
- 25.4
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic class
Define a available column -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<List<com.inet.remote.gui.angular.usersorgroupsselection.UsersOrGroupsSelection.SelectedMember>>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataField[]>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.crosstab.CrosstabDataField[]>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
static final com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataFilter>
Key for initial filterstatic final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableColumnData[]>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableSortingData[]>
static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>>
static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<String>
static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<PersistenceTemplateDataViewDefaults.Join>>
static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.dataview.DataViewDefinition>
static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>>
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
applySpecialFormat
(@Nonnull com.inet.report.FieldElement el) Apply special formats like text interpretation from the template@Nonnull DataView
createDataView
(@Nonnull com.inet.report.Engine engine, @Nullable DataFilter filter) Create a DataView.default <T> T
get
(@Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default value@Nonnull DataViewAccessList
The groups and/or users that have access to this template.@Nonnull List<@Nonnull TemplateDataViewDefaults.Column>
The list of available columns.default @Nullable String
Get a optional description, can be localizeddefault @Nonnull String
Get the localized displaynamedefault @Nullable List<com.inet.config.structure.model.LocalizedKey>
getFilterSuggestions
(@Nonnull com.inet.report.Engine engine, @Nonnull String filterColumn, @Nonnull String filterText) Get optional suggestions for possible values of filter for up to 50 value suggestions for the given filter@Nonnull com.inet.id.GUID
getID()
Returns unique ID of the template.default <T> @Nullable String
getString
(@Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default valuedefault boolean
hasAccess
(@Nonnull com.inet.id.GUID accountID) Returns whether specified user has access to this template data view.default void
setSelectionFormula
(@Nonnull com.inet.report.Engine engine, @Nullable DataFilter filter) Create the record selection formula in the Engine from the filter.Methods inherited from interface com.inet.plugin.NamedExtension
getExtensionName
-
Field Details
-
TEMPLATESOURCE_KEY
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.dataview.DataViewDefinition> TEMPLATESOURCE_KEY -
TEMPLATESOURCE_DATASOURCE
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<String> TEMPLATESOURCE_DATASOURCE -
TEMPLATESOURCE_TABLES_KEY
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>> TEMPLATESOURCE_TABLES_KEY -
TEMPLATESOURCE_JOINS_KEY
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<PersistenceTemplateDataViewDefaults.Join>> TEMPLATESOURCE_JOINS_KEY -
TEMPLATESOURCE_COLUMNS_KEY
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.dataview.DataViewPropertyKey<List<com.inet.config.structure.model.LocalizedKey>> TEMPLATESOURCE_COLUMNS_KEY -
ACCESS_LIST_KEY
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<List<com.inet.remote.gui.angular.usersorgroupsselection.UsersOrGroupsSelection.SelectedMember>> ACCESS_LIST_KEY -
FILTER_DEFINITION
static final com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataFilter> FILTER_DEFINITIONKey for initial filter -
TABLE_COLUMNS
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableColumnData[]> TABLE_COLUMNS -
TABLE_GROUPS
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> TABLE_GROUPS -
TABLE_SORTING
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.table.TableSortingData[]> TABLE_SORTING -
CROSSTAB_COLUMNS
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> CROSSTAB_COLUMNS -
CROSSTAB_ROWS
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> CROSSTAB_ROWS -
CROSSTAB_DATA
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.crosstab.CrosstabDataField[]> CROSSTAB_DATA -
CROSSTAB_GROUPS
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData[]> CROSSTAB_GROUPS -
CHART_CATEGORY
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<com.inet.report.adhoc.server.api.renderer.GroupData> CHART_CATEGORY -
CHART_DATA_FIELDS
@Nonnull static final @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<DataField[]> CHART_DATA_FIELDS
-
-
Method Details
-
getID
@Nonnull @Nonnull com.inet.id.GUID getID()Returns unique ID of the template.- Returns:
- uniqueID of the template.
- Since:
- 25.4
-
getDisplayName
Get the localized displayname- Returns:
- the displayname
- Since:
- 25.4
-
getDescription
Get a optional description, can be localized- Returns:
- the description
- Since:
- 25.4
-
get
@Nullable default <T> T get(@Nonnull @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default value- Since:
- 25.4
-
getString
@Nullable default <T> @Nullable String getString(@Nonnull @Nonnull com.inet.report.adhoc.server.api.renderer.RendererPropertyKey<T> key) Get a default value- Since:
- 25.4
-
getAccessList
The groups and/or users that have access to this template.- Returns:
- user with permissions
- Since:
- 25.4
-
hasAccess
default boolean hasAccess(@Nonnull @Nonnull com.inet.id.GUID accountID) Returns whether specified user has access to this template data view.- Parameters:
accountID
- ID of user account.- Returns:
- whether specified user has access to data view.
- Since:
- 25.4
-
getAvailableColumns
The list of available columns. It must contains minimum one field.- Returns:
- the columns
- Since:
- 25.4
-
createDataView
@Nonnull @Nonnull DataView createDataView(@Nonnull @Nonnull com.inet.report.Engine engine, @Nullable @Nullable DataFilter filter) Create a DataView. This means to add data definition to the given Engine- Parameters:
engine
- sub/main engine for a specific renderer formatfilter
- the saved filter definition- Returns:
- the DataView
- Since:
- 25.4
-
setSelectionFormula
default void setSelectionFormula(@Nonnull @Nonnull com.inet.report.Engine engine, @Nullable @Nullable DataFilter filter) throws com.inet.report.ReportException Create the record selection formula in the Engine from the filter.- Parameters:
engine
- the enginefilter
- the saved filter definition- Throws:
com.inet.report.ReportException
- should not occur- Since:
- 25.4
-
getFilterSuggestions
@Nullable default @Nullable List<com.inet.config.structure.model.LocalizedKey> getFilterSuggestions(@Nonnull @Nonnull com.inet.report.Engine engine, @Nonnull @Nonnull String filterColumn, @Nonnull @Nonnull String filterText) Get optional suggestions for possible values of filter for up to 50 value suggestions for the given filter- Parameters:
engine
- engine with data source settingsfilterColumn
- the column of the filterfilterText
- the entered filter text- Returns:
- the suggestions or null if the default should be used
- Since:
- 25.4
-
applySpecialFormat
default void applySpecialFormat(@Nonnull @Nonnull com.inet.report.FieldElement el) throws com.inet.report.ReportException Apply special formats like text interpretation from the template- Parameters:
el
- the field element with all formats- Throws:
com.inet.report.ReportException
- if any error occur with the reporting API- Since:
- 25.4
-