Package org.ametys.plugins.forms.helper

Class FormAdminDashboardHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.forms.helper.FormAdminDashboardHelper

All Implemented Interfaces:

LogEnabled, Component, Serviceable

public class FormAdminDashboardHelper
extends AbstractLogEnabled
implements Serviceable, Component

The helper to handle admin dashboard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FormAdminDashboardHelper.DashboardAdminParameters	A record grouping all parameters needed for searching form entries in the admin dashboard
static final record	FormAdminDashboardHelper.FormEntryDashboardColumn	Record representing a column for form entry display

Field Summary

Fields

Modifier and Type	Field	Description
protected AdvancedQueryBuilder	_advancedQueryBuilder	The builder of advanced queries
protected ModelItemTypeExtensionPoint	_criterionTypeExtensionPoint	The criterion type extension point
protected FormDAO	_formDAO	The form DAO
protected FormEntriesSearchHelper	_formEntriesSearchHelper	The form entries search helper
protected FormEntryDAO	_formEntryDAO	The form entry DAO
protected JSONUtils	_json	The JSON utils
protected AmetysObjectResolver	_resolver	The Ametys Object resolver
protected TreeMaker	_treeMaker	The tree maker
protected UserManager	_userManager	The user manager
static final String	ACTIONS_COLUMN_NAME	The name of the column to display form entry actions
static final String	COLUMN_NAME_PREFIX	Prefix for the name of column based on form entry.
static final String	CONFIGURE_DASHBOARD_RIGHT_ID	The id of the right to access the dashboard configuration.
static final String	HISTORY_COLUMN_NAME	The name of the column to display form entry history
static final String	LABEL_COLUMN_NAME	The name of the column to display form entry data
static final String	QUESTION_COLUMN_NAME_PREFIX	Prefix for the name of column based on form question.
static final String	ROLE	Avalon ROLE.

Constructor Summary

Constructors

Constructor	Description
FormAdminDashboardHelper()

Method Summary

Modifier and Type	Method	Description
boolean	actionableEntriesOnly(ZoneItem zoneItem)	true if the dashboard should display only entries on which the current user has at least one available action, false if it should display all entries on which the current user has read rights.
AbstractTreeNode<SearchServiceCriterion<?>>	createCriterionTree(Form form, Map<String,Object> contextualParameters)	Create the criterion tree for a form based on the search criteria JSON stored on the form.
List<SearchServiceCriterionDefinition>	getAllCriterionDefinitions(Form form)	Get all criterion definitions for a given form.
Map<String,Object>	getCriteriaValues(Request request, Form form)	Get a map of criterion name / criterion value from the request parameters
FormAdminDashboardHelper.DashboardAdminParameters	getDashboardAdminParameters(Request request, ZoneItem zoneItem, Form form, Map<String,Object> contextualParameters)	Get the parameters needed for the admin dashboard, based on the request parameters and the form configuration.
String[]	getDefaultColumns(Form form)	Get the default columns to display for a form in the admin dashboard.
String	getDefaultCriteriaAsJson(Form form)	Get the default search criteria for a form as a JSON string.
protected List<AbstractFormEntrySearchCriterionDefinition>	getFormCommonCriterionDefinitions(Form form)	Get form common criterion definitions for a given form.
Map<String,Map<String,Object>>	getFormCriterionDefinitions(String formId)	Gets the criterion definitions for a given form.
List<FormAdminDashboardHelper.FormEntryDashboardColumn>	getFormEntryColumns(Form form)	Get all form entry columns for a given form
protected List<FormQuestionSearchCriterionDefinition>	getFormQuestionCriterionDefinitions(Form form)	Get form question criterion definitions for a given form.
List<Form>	getForms(String siteName, boolean actionableEntriesOnly)	Get the accessible forms from admin dashboard for current user ie, forms with at least one entry on which the current user can perform an action
Map<String,Object>	getFormSearchConfiguration(String formId)	Gets the column definitions for a given form and the saved search configuration if exists.
protected List<AbstractFormEntrySearchCriterionDefinition>	getFormWorkflowCriterionDefinitions(Form form)	Get form workflow criterion definitions for a given form.
Query	getQuery(AbstractTreeNode<SearchServiceCriterion<?>> tree, Map<String,Object> criteriaValues, String lang, Map<String,Object> contextualParameters)	Build a query from a criterion tree and user criteria values.
Map<String,SearcherFactory.SortDefinition>	getSortDefinitions(FormAdminDashboardHelper.DashboardAdminParameters dashboardAdminParameters)	Get a map of column name / sort definition from the request parameters
void	saveSearchConfiguration(String formId, String criteriaJson, List<String> columns, String initialSortColumn, String initialSortOrder)	Save the search configuration (criteria and columns) on a form.
void	service(ServiceManager manager)
void	updateDashboardConfigOnQuestionDelete(Form form, String questionName)	Update the dashboard configuration of a form when a question is deleted.
void	updateDashboardConfigOnQuestionRename(Form form, String oldQuestionName, String newQuestionName)	Update the dashboard configuration of a form when a question is renamed.

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon ROLE.

COLUMN_NAME_PREFIX

public static final String COLUMN_NAME_PREFIX

Prefix for the name of column based on form entry.

See Also:

• Constant Field Values

QUESTION_COLUMN_NAME_PREFIX

public static final String QUESTION_COLUMN_NAME_PREFIX

Prefix for the name of column based on form question.

See Also:

• Constant Field Values

LABEL_COLUMN_NAME

public static final String LABEL_COLUMN_NAME

The name of the column to display form entry data

See Also:

• Constant Field Values

HISTORY_COLUMN_NAME

public static final String HISTORY_COLUMN_NAME

The name of the column to display form entry history

See Also:

• Constant Field Values

ACTIONS_COLUMN_NAME

public static final String ACTIONS_COLUMN_NAME

The name of the column to display form entry actions

See Also:

• Constant Field Values

CONFIGURE_DASHBOARD_RIGHT_ID

public static final String CONFIGURE_DASHBOARD_RIGHT_ID

The id of the right to access the dashboard configuration.

See Also:

• Constant Field Values

_resolver

protected AmetysObjectResolver _resolver

The Ametys Object resolver

_criterionTypeExtensionPoint

protected ModelItemTypeExtensionPoint _criterionTypeExtensionPoint

The criterion type extension point

_treeMaker

protected TreeMaker _treeMaker

The tree maker

_json

protected JSONUtils _json

The JSON utils

_advancedQueryBuilder

protected AdvancedQueryBuilder _advancedQueryBuilder

The builder of advanced queries

_formEntryDAO

protected FormEntryDAO _formEntryDAO

The form entry DAO

_formDAO

protected FormDAO _formDAO

The form DAO

_userManager

protected UserManager _userManager

The user manager

_formEntriesSearchHelper

protected FormEntriesSearchHelper _formEntriesSearchHelper

The form entries search helper

Constructor Details

FormAdminDashboardHelper

public FormAdminDashboardHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

getDashboardAdminParameters

public FormAdminDashboardHelper.DashboardAdminParameters getDashboardAdminParameters(Request request,
 ZoneItem zoneItem,
 Form form,
 Map<String,Object> contextualParameters)

Get the parameters needed for the admin dashboard, based on the request parameters and the form configuration.

Parameters:

request - the request containing the search parameters

zoneItem - the zone item holding the admin dashboard

form - the form

contextualParameters - the contextual parameters

Returns:

the dashboard search parameters built from the request parameters and the form configuration

actionableEntriesOnly

public boolean actionableEntriesOnly(ZoneItem zoneItem)

true if the dashboard should display only entries on which the current user has at least one available action, false if it should display all entries on which the current user has read rights.

Parameters:

zoneItem - the zone item holding the admin dashboard

Returns:

true if the dashboard should display only entries on which the current user has at least one available action, false if it should display all entries on which the current user has read rights

getSortDefinitions

public Map<String,SearcherFactory.SortDefinition> getSortDefinitions(FormAdminDashboardHelper.DashboardAdminParameters dashboardAdminParameters)

Get a map of column name / sort definition from the request parameters

Parameters:

dashboardAdminParameters - the dashboard admin parameters

Returns:

a map of column name / sort definition from the request parameters

getCriteriaValues

public Map<String,Object> getCriteriaValues(Request request,
 Form form)

Get a map of criterion name / criterion value from the request parameters

Parameters:

request - the request

form - the form

Returns:

a map of criterion name / criterion value from the request parameters

createCriterionTree

public AbstractTreeNode<SearchServiceCriterion<?>> createCriterionTree(Form form,
 Map<String,Object> contextualParameters)

Create the criterion tree for a form based on the search criteria JSON stored on the form.

Parameters:

form - the form

contextualParameters - the contextual parameters

Returns:

the criterion tree

getQuery

public Query getQuery(AbstractTreeNode<SearchServiceCriterion<?>> tree,
 Map<String,Object> criteriaValues,
 String lang,
 Map<String,Object> contextualParameters)

Build a query from a criterion tree and user criteria values.

Parameters:

tree - the criterion tree

criteriaValues - the user criteria values, as a map of criterion name to value

lang - the language to use for building the query

contextualParameters - the contextual parameters

Returns:

the built query

getFormCommonCriterionDefinitions

protected List<AbstractFormEntrySearchCriterionDefinition> getFormCommonCriterionDefinitions(Form form)

Get form common criterion definitions for a given form.

Parameters:

form - the form

Returns:

the list of form common criterion definitions

getFormWorkflowCriterionDefinitions

protected List<AbstractFormEntrySearchCriterionDefinition> getFormWorkflowCriterionDefinitions(Form form)

Get form workflow criterion definitions for a given form.

Parameters:

form - the form

Returns:

the list of form workflow criterion definitions

getFormQuestionCriterionDefinitions

protected List<FormQuestionSearchCriterionDefinition> getFormQuestionCriterionDefinitions(Form form)

Get form question criterion definitions for a given form.

Parameters:

form - the form

Returns:

the list of form question criterion definitions

getAllCriterionDefinitions

public List<SearchServiceCriterionDefinition> getAllCriterionDefinitions(Form form)

Get all criterion definitions for a given form.

Parameters:

form - the form

Returns:

the list of all criterion definition

getFormEntryColumns

public List<FormAdminDashboardHelper.FormEntryDashboardColumn> getFormEntryColumns(Form form)

Get all form entry columns for a given form

Parameters:

form - the given form

Returns:

the form entry columns

getFormCriterionDefinitions

public Map<String,Map<String,Object>> getFormCriterionDefinitions(String formId)

Gets the criterion definitions for a given form.

Parameters:

formId - The id of the form

Returns:

the criterion definitions as a map of criterion id to criterion properties

getFormSearchConfiguration

public Map<String,Object> getFormSearchConfiguration(String formId)

Gets the column definitions for a given form and the saved search configuration if exists.

Parameters:

formId - The id of the form

Returns:

a map with "columns" (list of column definitions) and "savedConfiguration" (map with "criteria", "columns", "initialSortColumn", "initialSortOrder")

saveSearchConfiguration

public void saveSearchConfiguration(String formId,
 String criteriaJson,
 List<String> columns,
 String initialSortColumn,
 String initialSortOrder)

Save the search configuration (criteria and columns) on a form.

Parameters:

formId - The id of the form

criteriaJson - The criteria as a JSON string

columns - The list of column names

initialSortColumn - The initial sort column name. Can be null or empty

initialSortOrder - The initial sort order (ASC or DESC). Can be null or empty

getForms

public List<Form> getForms(String siteName,
 boolean actionableEntriesOnly)

Get the accessible forms from admin dashboard for current user ie, forms with at least one entry on which the current user can perform an action

Parameters:

siteName - the sitename

actionableEntriesOnly - true if the dashboard should display only entries on which the current user has at least one available action, false if it should display all entries on which the current user has read rights

Returns:

the accessible forms from admin dasboard for current user

getDefaultCriteriaAsJson

public String getDefaultCriteriaAsJson(Form form)

Get the default search criteria for a form as a JSON string.

Parameters:

form - the form

Returns:

the default search criteria for a form as a JSON string

getDefaultColumns

public String[] getDefaultColumns(Form form)

Get the default columns to display for a form in the admin dashboard.

Parameters:

form - the form

Returns:

the default columns to display for a form in the admin dashboard

updateDashboardConfigOnQuestionRename

public void updateDashboardConfigOnQuestionRename(Form form,
 String oldQuestionName,
 String newQuestionName)

Update the dashboard configuration of a form when a question is renamed.

Parameters:

form - the form

oldQuestionName - the old name of the question

newQuestionName - the new name of the question

updateDashboardConfigOnQuestionDelete

public void updateDashboardConfigOnQuestionDelete(Form form,
 String questionName)

Update the dashboard configuration of a form when a question is deleted.

Parameters:

form - the form

questionName - the name of the deleted question