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

Class PluginTemplateReplacerParams

java.lang.Object

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

All Implemented Interfaces:

IPluginParameters, IPluginGenericReplacerParams, IPluginTemplateReplacerParams

public class PluginTemplateReplacerParams
extends Object
implements IPluginTemplateReplacerParams

Constructor Summary

Constructors

Constructor	Description
PluginTemplateReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, Mandant man)	Deprecated. Use PluginTemplateReplacerParams(IEntityContext, String, String, ITemplateReplacerParams).
PluginTemplateReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, ITemplateReplacerParams parameters)

Method Summary

Modifier and Type	Method	Description
IEntityContext	getEntityContext()
IPlaceholderEscaper	getEscaper()
Mandant	getMandant()
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.IPluginGenericReplacerParams

getEntityContext, getEscaper, getPlaceholder, getPlaceholderContent

Constructor Detail

PluginTemplateReplacerParams

public PluginTemplateReplacerParams(IEntityContext ec,
                                    String placeholder,
                                    String placeholderContent,
                                    ITemplateReplacerParams parameters)

PluginTemplateReplacerParams

@Deprecated
public PluginTemplateReplacerParams(IEntityContext ec,
                                    String placeholder,
                                    String placeholderContent,
                                    Mandant man)

Deprecated.

Use PluginTemplateReplacerParams(IEntityContext, String, String, ITemplateReplacerParams).

Parameters:

ec - Current entity context for database interaction.

placeholder - Placeholder to process.

placeholderContent - Content of the placeholder to process.

man - Current client.

Method Detail

getMandant

public Mandant getMandant()

Specified by:

getMandant in interface IPluginTemplateReplacerParams

Returns:

The current Mandant. May be used to retrieve a certain Textbaustein of that client.

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()