Package org.ametys.plugins.forms.helper

Record Class FormAdminDashboardHelper.DashboardAdminParameters

java.lang.Object

java.lang.Record

org.ametys.plugins.forms.helper.FormAdminDashboardHelper.DashboardAdminParameters

Record Components:

form - the form

criterionTree - the criterion tree for form entry search

userInputs - the form search user inputs

actionableEntriesOnly - whether to filter only entries with at least one available action for the current user

lang - the form locale

Enclosing class:

FormAdminDashboardHelper

public static record FormAdminDashboardHelper.DashboardAdminParameters(Form form, AbstractTreeNode<SearchServiceCriterion<?>> criterionTree, FormSearchUserInputs userInputs, boolean actionableEntriesOnly, String lang)
extends Record

A record grouping all parameters needed for searching form entries in the admin dashboard

Constructor Summary

Constructors

Constructor	Description
DashboardAdminParameters(Form form, AbstractTreeNode<SearchServiceCriterion<?>> criterionTree, FormSearchUserInputs userInputs, boolean actionableEntriesOnly, String lang)	Creates an instance of a DashboardAdminParameters record class.

Method Summary

Modifier and Type	Method	Description
boolean	actionableEntriesOnly()	Returns the value of the actionableEntriesOnly record component.
AbstractTreeNode<SearchServiceCriterion<?>>	criterionTree()	Returns the value of the criterionTree record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Form	form()	Returns the value of the form record component.
final int	hashCode()	Returns a hash code value for this object.
String	lang()	Returns the value of the lang record component.
final String	toString()	Returns a string representation of this record class.
FormSearchUserInputs	userInputs()	Returns the value of the userInputs record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DashboardAdminParameters

public DashboardAdminParameters(Form form,
 AbstractTreeNode<SearchServiceCriterion<?>> criterionTree,
 FormSearchUserInputs userInputs,
 boolean actionableEntriesOnly,
 String lang)

Creates an instance of a DashboardAdminParameters record class.

Parameters:

form - the value for the form record component

criterionTree - the value for the criterionTree record component

userInputs - the value for the userInputs record component

actionableEntriesOnly - the value for the actionableEntriesOnly record component

lang - the value for the lang record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

form

public Form form()

Returns the value of the form record component.

Returns:

the value of the form record component

criterionTree

public AbstractTreeNode<SearchServiceCriterion<?>> criterionTree()

Returns the value of the criterionTree record component.

Returns:

the value of the criterionTree record component

userInputs

public FormSearchUserInputs userInputs()

Returns the value of the userInputs record component.

Returns:

the value of the userInputs record component

actionableEntriesOnly

public boolean actionableEntriesOnly()

Returns the value of the actionableEntriesOnly record component.

Returns:

the value of the actionableEntriesOnly record component

lang

public String lang()

Returns the value of the lang record component.

Returns:

the value of the lang record component