IPlaceholderValueParams (formcycle: bom 8.3.7 API)

All Superinterfaces:

IContextReplacerParams, IFormReplacerParams, II18nValueReplacerParams, ILanguageTagProviding, IReplacerParams, ISessionReplacerParams, ISystemReplacerParams, ITemplateReplacerParams, Serializable

All Known Implementing Classes:

DefaultReplacerParameters
```
public interface IPlaceholderValueParams
extends IFormReplacerParams, ISessionReplacerParams, ITemplateReplacerParams, ISystemReplacerParams, IContextReplacerParams, II18nValueReplacerParams
```
Interface for placeholder params that implements all interfaces for the different placeholder types.

Author:

XIMA MEDIA GmbH

Nested Class Summary
- Nested classes/interfaces inherited from interface de.xima.fc.interfaces.placeholder.params.IContextReplacerParams
  IContextReplacerParams.IValueReplacer

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default Clock`	`getClock()`
`default IPlaceholderEscaper`	`getEscaper()`	The placeholder escaper, which should applied for the replaced placeholder values before they returned to the document
`FormVersion`	`getFormVersion()`	Gets the form version from the current context where the placeholder is used, if available.

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.IContextReplacerParams
getPlaceholderMap, getReplacerMap, isReplaceContextPlaceholders

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.IFormReplacerParams
getClient, getFieldRepetitions, getFormData, getLanguageTag, getProcess, getRepetitionContainer, isEncodeForHTML, isEncodeFormValuesForPlaceholder, isReplaceFormPlaceholders, setFormData

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.II18nValueReplacerParams
getClient, isEncodeForHTML, isReplaceI18nPlaceholders

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.ISessionReplacerParams
getBaseUrl, getContextPath, getProcess, getRequest, getResponse, getSessionId, isReplaceSessionPlaceholders

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.ISystemReplacerParams
getClient, getContextPath, getCreatorDataJSON, getEditorDataJSON, getFormData, getProcess, getProject, getUserDataJSON, getWorkflowExecutionContext, getWorkflowProcessing, isReplaceSystemPlaceholders, setFormData

Methods inherited from interface de.xima.fc.interfaces.placeholder.params.ITemplateReplacerParams
getClient, isReplaceTemplatePlaceholders

- Method Detail
  - getEscaper
```
default IPlaceholderEscaper getEscaper()
```
    The placeholder escaper, which should applied for the replaced placeholder values before they returned to the document
    
    Specified by:
    
    getEscaper in interface IFormReplacerParams
    
    Specified by:
    
    getEscaper in interface IReplacerParams
    
    Returns:
    
    an instance of IPlaceholderEscaper
  - getFormVersion
```
FormVersion getFormVersion()
```
    Description copied from interface: ISystemReplacerParams
    
    Gets the form version from the current context where the placeholder is used, if available.
    
    Specified by:
    
    getFormVersion in interface IFormReplacerParams
    
    Specified by:
    
    getFormVersion in interface ISystemReplacerParams
    
    Returns:
    
    The form version context, if any, for which the placeholder replacement is performed.
  - getClock
```
default Clock getClock()
```
    Specified by:
    
    getClock in interface ISessionReplacerParams
    
    Specified by:
    
    getClock in interface ISystemReplacerParams
    
    Returns:
    
    The clock to use for obtaining the current time.