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

Class PluginSessionReplacerParams

java.lang.Object

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

All Implemented Interfaces:

IPluginParameters, IPluginGenericReplacerParams, IPluginSessionReplacerParams

public class PluginSessionReplacerParams
extends Object
implements IPluginSessionReplacerParams

Constructor Summary

Constructors

Constructor	Description
PluginSessionReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, Vorgang vorgang, String sessionID, String contextName)	Deprecated. Use PluginSessionReplacerParams(IEntityContext, String, String, ISessionReplacerParams).
PluginSessionReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, ISessionReplacerParams parameters)

Method Summary

Modifier and Type	Method	Description
String	getContextName()
IEntityContext	getEntityContext()
IPlaceholderEscaper	getEscaper()
String	getPlaceholder()
String	getPlaceholderContent()
String	getSessionId()
Vorgang	getVorgang()

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.IPluginSessionReplacerParams

getEntityContext, getPlaceholder, getPlaceholderContent

Constructor Detail

PluginSessionReplacerParams

public PluginSessionReplacerParams(IEntityContext ec,
                                   String placeholder,
                                   String placeholderContent,
                                   ISessionReplacerParams parameters)

PluginSessionReplacerParams

@Deprecated
public PluginSessionReplacerParams(IEntityContext ec,
                                   String placeholder,
                                   String placeholderContent,
                                   Vorgang vorgang,
                                   String sessionID,
                                   String contextName)

Deprecated.

Use PluginSessionReplacerParams(IEntityContext, String, String, ISessionReplacerParams).

Parameters:

ec - Current entity context for database interaction.

placeholder - Placeholder to process.

placeholderContent - Content of the placeholder to process.

vorgang - Current form record being processed.

sessionID - Current ID of the HTTP session.

contextName - Name of the context where the web app is running.

Method Detail

getSessionId

public String getSessionId()

Specified by:

getSessionId in interface IPluginSessionReplacerParams

Returns:

The current session ID of the HttpSession.

getContextName

public String getContextName()

Specified by:

getContextName in interface IPluginSessionReplacerParams

Returns:

The current context name of the web application.

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IPluginSessionReplacerParams

Returns:

The current Vorgang, if there is one.

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