AdditionalSearchServiceParameter (Ametys 4.3.x - API)

java.lang.Object
- org.ametys.web.frontoffice.search.metamodel.AdditionalSearchServiceParameter<T>

Type Parameters:

T - Type of the parameter
```
public final class AdditionalSearchServiceParameter<T>
extends Object
```
This class is a wrapper of an additional parameter for a search service instance (brought by a Searchable or a Returnable, throuh AbstractParameterAdderSearchable or AbstractParameterAdderReturnable for instance).
It holds the actual ServiceParameter, and a boolean indicating if in client-side, the change of the field of this parameter must lead to a reload of the search criteria.

Field Summary

Fields
Modifier and Type Field Description

private boolean _reloadCriteriaOnChange

private ServiceParameter<T> _serviceParameter

Constructor Summary

Constructors
Constructor	Description
`AdditionalSearchServiceParameter(ServiceParameter<T> serviceParameter, boolean reloadCriteriaOnChange)`	Constructs the AdditionalSearchServiceParameter

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ServiceParameter<T>`	`getParameter()`	Gets the additional service parameter
`boolean`	`reloadCriteriaOnChange()`	Returns `true` if in client-side, the change of the field of this parameter must lead to a reload of the search criteria

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _serviceParameter
```
private ServiceParameter<T> _serviceParameter
```
  - _reloadCriteriaOnChange
```
private boolean _reloadCriteriaOnChange
```
- Constructor Detail
  - AdditionalSearchServiceParameter
```
public AdditionalSearchServiceParameter(ServiceParameter<T> serviceParameter,
                                        boolean reloadCriteriaOnChange)
```
    Constructs the AdditionalSearchServiceParameter
    
    Parameters:
    
    serviceParameter - the actual search service additional parameter
    
    reloadCriteriaOnChange - Set this to true if in client-side, the change of the field of this parameter must lead to a reload of the search criteria
- Method Detail
  - getParameter
```
public ServiceParameter<T> getParameter()
```
    Gets the additional service parameter
    
    Returns:
    
    the additional service parameter
  - reloadCriteriaOnChange
```
public boolean reloadCriteriaOnChange()
```
    Returns true if in client-side, the change of the field of this parameter must lead to a reload of the search criteria
    
    Returns:
    
    true if in client-side, the change of the field of this parameter must lead to a reload of the search criteria