Package de.xima.fc.plugin.models.params.replacer

Class PluginFormReplacerParams

java.lang.Object

de.xima.fc.plugin.models.params.replacer.PluginFormReplacerParams

All Implemented Interfaces:

IPluginParameters, IPluginFormReplacerParams, IPluginGenericReplacerParams

public class PluginFormReplacerParams
extends Object
implements IPluginFormReplacerParams

Constructor Summary

Constructors

Constructor	Description
PluginFormReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, IFormDataAdapter fda, FormVersion formversion)	Deprecated. Use PluginFormReplacerParams(IEntityContext, String, String, IFormReplacerParams).
PluginFormReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, IFormReplacerParams parameters)

Method Summary

Modifier and Type	Method	Description
IEntityContext	getEntityContext()
IPlaceholderEscaper	getEscaper()
IFormDataAdapter	getFormDataAdapter()
FormVersion	getFormversion()
String	getPlaceholder()
String	getPlaceholderContent()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.plugin.param.replacer.IPluginFormReplacerParams

isEncodeForHTML

Methods inherited from interface de.xima.fc.interfaces.plugin.param.replacer.IPluginGenericReplacerParams

getEntityContext, getEscaper, getPlaceholder, getPlaceholderContent

Constructor Detail

PluginFormReplacerParams

public PluginFormReplacerParams(IEntityContext ec,
                                String placeholder,
                                String placeholderContent,
                                IFormReplacerParams parameters)

PluginFormReplacerParams

@Deprecated
public PluginFormReplacerParams(IEntityContext ec,
                                String placeholder,
                                String placeholderContent,
                                IFormDataAdapter fda,
                                FormVersion formversion)

Deprecated.

Use PluginFormReplacerParams(IEntityContext, String, String, IFormReplacerParams).

Parameters:

ec - Current entity context for database interaction.

placeholder - Placeholder to process.

placeholderContent - Content of the placeholder to process.

fda - Current form data adapter with the submitted form data.

formversion - Current form version being processed.

Method Detail

getFormversion

public FormVersion getFormversion()

Specified by:

getFormversion in interface IPluginFormReplacerParams

Returns:

The current FormVersion for which the replacement is being performed.

getFormDataAdapter

public IFormDataAdapter getFormDataAdapter()

Specified by:

getFormDataAdapter in interface IPluginFormReplacerParams

Returns:

The IFormDataAdapter that you can use to access the form data of the current FormEingang.

getEntityContext

public IEntityContext getEntityContext()

Specified by:

getEntityContext in interface IPluginGenericReplacerParams

Returns:

An IEntityContext that can be used to send queries to the database.

getEscaper

public IPlaceholderEscaper getEscaper()

Specified by:

getEscaper in interface IPluginGenericReplacerParams

Returns:

The escaper for post-processing the replaced values. You should call IPlaceholderEscaper.escape(String, de.xima.fc.interfaces.placeholder.params.EPlaceholderType) on the replaced value.

getPlaceholder

public String getPlaceholder()

Specified by:

getPlaceholder in interface IPluginGenericReplacerParams

Returns:

The entire placeholder, including the name of the placeholder as well as the prefix and the suffix, such as [%tf1%].

See Also:

IPluginGenericReplacerParams.getPlaceholderContent()

getPlaceholderContent

public String getPlaceholderContent()

Specified by:

getPlaceholderContent in interface IPluginGenericReplacerParams

Returns:

The name of the placeholder, without the prefix and the suffix, such as tf1.

See Also:

IPluginGenericReplacerParams.getPlaceholder()