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

Class PluginSystemReplacerParams

java.lang.Object

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

All Implemented Interfaces:

IPluginParameters, IPluginGenericReplacerParams, IPluginSystemReplacerParams

public class PluginSystemReplacerParams
extends Object
implements IPluginSystemReplacerParams

Constructor Summary

Constructors

Constructor	Description
PluginSystemReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, ISystemReplacerParams parameters)
PluginSystemReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, IWorkflowProcessingContext wpc, Mandant client)	Deprecated. Use PluginSystemReplacerParams(IEntityContext, String, String, ISystemReplacerParams).
PluginSystemReplacerParams(IEntityContext ec, String placeholder, String placeholderContent, IBaseWorkflowExecutionContext wpc, Mandant client)	Deprecated. Use PluginSystemReplacerParams(IEntityContext, String, String, ISystemReplacerParams).

Method Summary

Modifier and Type	Method	Description
Mandant	getClient()
IEntityContext	getEntityContext()
IPlaceholderEscaper	getEscaper()
String	getPlaceholder()
String	getPlaceholderContent()
IBaseWorkflowExecutionContext	getWorkflowExecutionContext()
IWorkflowProcessingContext	getWorkflowProcessingContext()

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

PluginSystemReplacerParams

public PluginSystemReplacerParams(IEntityContext ec,
                                  String placeholder,
                                  String placeholderContent,
                                  ISystemReplacerParams parameters)

PluginSystemReplacerParams

@Deprecated
public PluginSystemReplacerParams(IEntityContext ec,
                                  String placeholder,
                                  String placeholderContent,
                                  IWorkflowProcessingContext wpc,
                                  Mandant client)

Deprecated.

Use PluginSystemReplacerParams(IEntityContext, String, String, ISystemReplacerParams).

Parameters:

ec - Current entity context for database interaction.

placeholder - Placeholder to process.

placeholderContent - Content of the placeholder to process.

wpc - Current workflow processing context.

PluginSystemReplacerParams

@Deprecated
public PluginSystemReplacerParams(IEntityContext ec,
                                  String placeholder,
                                  String placeholderContent,
                                  IBaseWorkflowExecutionContext wpc,
                                  Mandant client)

Deprecated.

Use PluginSystemReplacerParams(IEntityContext, String, String, ISystemReplacerParams).

Parameters:

ec - Current entity context for database interaction.

placeholder - Placeholder to process.

placeholderContent - Content of the placeholder to process.

wpc - Current workflow processing context.

client - Current client.

Method Detail

getWorkflowProcessingContext

public IWorkflowProcessingContext getWorkflowProcessingContext()

Specified by:

getWorkflowProcessingContext in interface IPluginSystemReplacerParams

Returns:

The current IWorkflowProcessingContext, in case the placeholder is used within a workflow action. It may be used to, for example, to access the current workflow Aktion or the current Vorgang.

getWorkflowExecutionContext

public IBaseWorkflowExecutionContext getWorkflowExecutionContext()

Specified by:

getWorkflowExecutionContext in interface IPluginSystemReplacerParams

Returns:

The current IBaseWorkflowExecutionContext, in case the placeholder is used within a workflow action. It may be used to, for example, to access the current workflow Aktion or the current Vorgang.

getClient

public Mandant getClient()

Specified by:

getClient in interface IPluginSystemReplacerParams

Returns:

The current client context where the replacement takes place.

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