IPluginFormReplacerParams (formcycle: bom 8.1.0-RC.8 API)

All Superinterfaces:

IPluginGenericReplacerParams, IPluginParameters

All Known Implementing Classes:

PluginFormReplacerParams
```
public interface IPluginFormReplacerParams
extends IPluginGenericReplacerParams
```
Interface that encapsulates the parameters for a form replacer plugin.

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default IFormDataAdapter`	`getFormDataAdapter()`	Deprecated. Use (@link #getFormReplacerParams()
`default FormVersion`	`getFormversion()`	Deprecated. Use (@link #getFormReplacerParams()
`IFormReplacerParams`	`getReplacerParams()`
`default boolean`	`isEncodeForHTML()`	Deprecated. Use `IPluginGenericReplacerParams.getEscaper()`.

Methods inherited from interface de.xima.fc.interfaces.plugin.param.replacer.IPluginGenericReplacerParams
getEntityContext, getEscaper, getPlaceholder, getPlaceholderContent

- Method Detail
  - getFormversion
```
@Deprecated
default FormVersion getFormversion()
```
    Deprecated.
    Use (@link #getFormReplacerParams()
    
    Returns:
    
    The current FormVersion for which the replacement is being performed.
  - getFormDataAdapter
```
@Deprecated
default IFormDataAdapter getFormDataAdapter()
```
    Deprecated.
    Use (@link #getFormReplacerParams()
    
    Returns:
    
    The IFormDataAdapter that you can use to access the form data of the current FormEingang.
  - getReplacerParams
```
IFormReplacerParams getReplacerParams()
```
    Specified by:
    
    getReplacerParams in interface IPluginGenericReplacerParams
    
    Returns:
    
    The IFormReplacerParams that you can use to access the form replacer params.
  - isEncodeForHTML
```
@Deprecated
default boolean isEncodeForHTML()
```
    Deprecated.
    Use IPluginGenericReplacerParams.getEscaper().
    
    Returns:
    
    Whether the replaced placeholder value must be escaped for HTML, eg. by replacing & with & etc.