Package de.xima.fc.api.system

Class PlaceholderAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.system.PlaceholderAPI

public class PlaceholderAPI
extends ASubAPI

API helper class.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
PlaceholderAPI()

Method Summary

Modifier and Type	Method	Description
String	parse(UserContext uc, String text, Vorgang formRecord, boolean encodeForHTML)	Deprecated. Use PlaceholderReplacer directly instead.
String	replaceI18nValiable(UserContext uc, Mandant client, String i18nKey, String languageTag, Object... params)	Deprecated. use replaceI18nVariable.
String	replaceI18nVariable(UserContext uc, Mandant client, String i18nKey, String languageTag, Object... params)
String	replaceSessionValues(UserContext uc, String context, String sessionId, String templateText, Vorgang v)	Deprecated. Use PlaceholderReplacer directly instead.

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

PlaceholderAPI

public PlaceholderAPI()

Method Detail

replaceSessionValues

@Deprecated
public String replaceSessionValues(UserContext uc,
                                   String context,
                                   String sessionId,
                                   String templateText,
                                   Vorgang v)

Deprecated.

Use PlaceholderReplacer directly instead.

Place system attributes at the location where the corresponding placeholders can be found.

Parameters:

uc - UserContext the user context in which the action is to be performed.

context - String the current context.

sessionId - String for determining session attributes.

templateText - String String in the placeholder to be replaced occur.

v - - Vorgang via which the system attributes are determined.

Returns:

parsed string.

Since:

2.4.3

parse

@Deprecated
public String parse(UserContext uc,
                    String text,
                    Vorgang formRecord,
                    boolean encodeForHTML)

Deprecated.

Use PlaceholderReplacer directly instead.

replaceI18nVariable

public String replaceI18nVariable(UserContext uc,
                                  Mandant client,
                                  String i18nKey,
                                  String languageTag,
                                  Object... params)

Parameters:

uc - User context for the replacment proces.

client - Client context for retrieving placeholder plugins.

i18nKey - Key to resolve.

languageTag - Language to use.

params - Additional parameters for arguments within the i18n message.

Returns:

The message for the given i18n key.

replaceI18nValiable

@Deprecated
public String replaceI18nValiable(UserContext uc,
                                  Mandant client,
                                  String i18nKey,
                                  String languageTag,
                                  Object... params)

Deprecated.

use replaceI18nVariable.

Parameters:

uc - User context for the replacment proces.

client - Client context for retrieving placeholder plugins.

i18nKey - Key to resolve.

languageTag - Language to use.

params - Additional parameters for arguments within the i18n message.

Returns:

The message for the given i18n key.