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

Interface IPluginSessionReplacerParams

All Superinterfaces:

IPluginGenericReplacerParams, IPluginParameters

All Known Implementing Classes:

PluginSessionReplacerParams

public interface IPluginSessionReplacerParams
extends IPluginGenericReplacerParams

Interface for the parameters of a session replacer plugin.

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
default String	getContextName()	Deprecated. Use getReplacerParams()
IEntityContext	getEntityContext()
String	getPlaceholder()
String	getPlaceholderContent()
ISessionReplacerParams	getReplacerParams()
default String	getSessionId()	Deprecated. Use getReplacerParams()
default Vorgang	getVorgang()	Deprecated. Use getReplacerParams()

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

getEscaper

Method Details

getEntityContext

IEntityContext getEntityContext()

Specified by:

getEntityContext in interface IPluginGenericReplacerParams

Returns:

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

getVorgang

@Deprecated
default Vorgang getVorgang()

Deprecated.

Use getReplacerParams()

Returns:

The current Vorgang, if there is one.

getPlaceholder

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

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

getSessionId

@Deprecated
default String getSessionId()

Deprecated.

Use getReplacerParams()

Returns:

The current session ID of the HttpSession.

getContextName

@Deprecated
default String getContextName()

Deprecated.

Use getReplacerParams()

Returns:

The current context name of the web application.

getReplacerParams

ISessionReplacerParams getReplacerParams()

Specified by:

getReplacerParams in interface IPluginGenericReplacerParams

Returns:

The current replacer parameters for the replacement process.