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

Interface IPluginGenericReplacerRetVal

All Superinterfaces:

IPluginReturnValue

All Known Subinterfaces:

IPluginFormReplacerRetVal, IPluginSessionReplacerRetVal, IPluginSystemReplacerRetVal, IPluginTemplateReplacerRetVal

All Known Implementing Classes:

PluginGenericReplacerRetVal

public interface IPluginGenericReplacerRetVal
extends IPluginReturnValue

Base interface for the return values of placeholder plugins.

Since:

8.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
String	getReplacedValue()	The value that should be used as the replacement for the placeholder.
default EPluginReplacementStatus	getReplacementStatus()	The status indicating whether the placeholder could be resolved.

Method Detail

getReplacedValue

String getReplacedValue()

The value that should be used as the replacement for the 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. When this returns null: The placeholder is considered not resolved if getReplacementStatus() is LEGACY; otherwise null is treated as the empty string.

getReplacementStatus

default EPluginReplacementStatus getReplacementStatus()

The status indicating whether the placeholder could be resolved. If it could be resolved, the getReplacedValue() is used as the replacement for the placeholder. If it could not be resolved, other placeholder plugin are tried, and if none of those plugins could resolve the placeholder, the default placeholder replacer is used.

Returns:

Whether the placeholder could be resolved.