IProcessingResult (FORMCYCLE: BOM 7.4.6-RC.2 API)

All Known Subinterfaces:

IPluginProcessingRetVal, IProcessingResultAktionsID, IProcessingResultFileData, IProcessingResultFilePath, IProcessingResultHTML, IProcessingResultIntValue, IProcessingResultLongValue, IProcessingResultMultiValue, IProcessingResultNumberValue, IProcessingResultStringValue, IProcessingResultSuccess, IProcessingResultTemplate, IProcessingResultVorgangsID, IProcessingResultWeiterleitung

All Known Implementing Classes:

AProcessingResult, ProcessingResultAktionsID, ProcessingResultFileData, ProcessingResultFilePath, ProcessingResultHTML, ProcessingResultIntValue, ProcessingResultLongValue, ProcessingResultMultiValue, ProcessingResultMultiValueAndFilePath, ProcessingResultNumberValue, ProcessingResultRedirect, ProcessingResultStringValue, ProcessingResultStringValueAndFilePath, ProcessingResultSuccess, ProcessingResultTemplate, ProcessingResultVorgangsID
```
public interface IProcessingResult
```
The result of running a workflow action.

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`getErrorCode()`
`default String`	`getErrorMessage()`
`String`	`getPlaceholderValue(int index, String key)`	In general, the result of an action is a `List` of `Map`s.
`default Map<String,Serializable>`	`getSessionAttributeMap()`	A map of key-value pairs with session attributes that are written to the `HttpSession`.
`boolean`	`getSuccessValue()`
`int`	`getValuesCount()`

- Method Detail
  - getPlaceholderValue
```
String getPlaceholderValue(int index,
                           String key)
```
    In general, the result of an action is a List of Maps. This return the value at a given index and key.
    
    Parameters:
    
    index - Index at which to retrieve the processing result value.
    
    key - Key at which to retrieve the processing result value.
    
    Returns:
    
    The processing result value at the given index and key.
  - getValuesCount
```
int getValuesCount()
```
    Returns:
    
    The number of values the workflow action returned.
  - getSuccessValue
```
boolean getSuccessValue()
```
    Returns:
    
    Whether the workflow action was executed successfully.
  - getErrorCode
```
default String getErrorCode()
```
    Returns:
    
    In case the workflow action was not successful, the error code.
  - getErrorMessage
```
default String getErrorMessage()
```
    Returns:
    
    In case the workflow action was not successful, the error message.
  - getSessionAttributeMap
```
default Map<String,Serializable> getSessionAttributeMap()
```
    A map of key-value pairs with session attributes that are written to the HttpSession. When the session already contains a value for a parameter, it is overwritten.
    
    Returns:
    
    A Map with session attributes to set on the HttpSession.
    
    Since:
    
    6.1