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

Class PluginGenericReplacerRetVal

java.lang.Object

de.xima.fc.plugin.models.retval.replacer.PluginGenericReplacerRetVal

All Implemented Interfaces:

IPluginReturnValue, IPluginFormReplacerRetVal, IPluginSessionReplacerRetVal, IPluginSystemReplacerRetVal, IPluginTemplateReplacerRetVal

public class PluginGenericReplacerRetVal
extends Object
implements IPluginFormReplacerRetVal, IPluginSessionReplacerRetVal, IPluginSystemReplacerRetVal, IPluginTemplateReplacerRetVal

Constructor Summary

Constructors

Constructor	Description
PluginGenericReplacerRetVal(String replacedValue)

Method Summary

Modifier and Type	Method	Description
String	getReplacedValue()	The value that should be used as the replacement for the form placeholder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PluginGenericReplacerRetVal

public PluginGenericReplacerRetVal(String replacedValue)

Method Detail

getReplacedValue

public String getReplacedValue()

Description copied from interface: IPluginFormReplacerRetVal

The value that should be used as the replacement for the form placeholder. This must be just the value, without any placeholder-specific prefixes or suffixes.

Also, a plugin may not want to handle all placeholders and delegate some placeholders to other plugins or to the default placeholder replacer. Return the name of the placeholder as the replaced value to indicate that the plugin cannot (or does not with to) handle that placeholder.

Specified by:

getReplacedValue in interface IPluginFormReplacerRetVal

Specified by:

getReplacedValue in interface IPluginSessionReplacerRetVal

Specified by:

getReplacedValue in interface IPluginSystemReplacerRetVal

Specified by:

getReplacedValue in interface IPluginTemplateReplacerRetVal

Returns:

The value to be used as the replacement for the placeholder.