Package de.xima.fc.interfaces.plugin.param.replacer

Interface IPluginGenericReplacerParams

All Superinterfaces:

IPluginParameters

All Known Subinterfaces:

IPluginFormReplacerParams, IPluginSessionReplacerParams, IPluginSystemReplacerParams, IPluginTemplateReplacerParams

All Known Implementing Classes:

PluginFormReplacerParams, PluginSessionReplacerParams, PluginSystemReplacerParams, PluginTemplateReplacerParams

public interface IPluginGenericReplacerParams
extends IPluginParameters

Interface for common parameters of all placeholder replace plugins.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IEntityContext	getEntityContext()
default IPlaceholderEscaper	getEscaper()	Deprecated. Use getReplacerParams()
String	getPlaceholder()
String	getPlaceholderContent()
IReplacerParams	getReplacerParams()

Method Details

getEntityContext

IEntityContext getEntityContext()

Returns:

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

getEscaper

@Deprecated
default IPlaceholderEscaper getEscaper()

Deprecated.

Use getReplacerParams()

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.

getReplacerParams

IReplacerParams getReplacerParams()

Returns:

The current replacer parameters for the replacement process.

Since:

7.0.7

getPlaceholder

String getPlaceholder()

Returns:

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

See Also:

• getPlaceholderContent()

getPlaceholderContent

String getPlaceholderContent()

Returns:

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

See Also:

• getPlaceholder()