de.xima.fc.interfaces.plugin.retval.replacer

Interface IPluginSystemReplacerRetVal

All Superinterfaces:

IPluginReturnValue

All Known Implementing Classes:

PluginGenericReplacerRetVal

public interface IPluginSystemReplacerRetVal
extends IPluginReturnValue

Interface for the return value of a system replacer plugin.

Author:

XIMA MEDIA GmbH

Method Summary

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

Method Detail

getReplacedValue

String getReplacedValue()

The value that should be used as the replacement for the system 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.

Returns:

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