de.xima.fc.bl.fdv.processing.result

Class ProcessingResultSuccess

java.lang.Object

de.xima.fc.bl.fdv.processing.result.AProcessingResult

de.xima.fc.bl.fdv.processing.result.ProcessingResultSuccess

All Implemented Interfaces:

IPluginReturnValue, IPluginProcessingRetVal, IProcessingResult, IProcessingResultSuccess

public class ProcessingResultSuccess
extends AProcessingResult
implements IProcessingResultSuccess

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor and Description
ProcessingResultSuccess(boolean success)
ProcessingResultSuccess(String errorCode, String errorMessage)
ProcessingResultSuccess(String errorCode, Throwable error)

Method Summary

Modifier and Type	Method and Description
String	getErrorCode()
String	getErrorMessage()
String	getPlaceholderValue(int index, String key) In general, the result of an action is a List of Maps.
int	getValuesCount()
void	setErrorCode(String errorCode)
void	setErrorMessage(String errorMessage)

Methods inherited from class de.xima.fc.bl.fdv.processing.result.AProcessingResult

getSessionAttributeMap, getSuccessValue, setSessionAttributeMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.xima.fc.interfaces.processing.IProcessingResult

getSessionAttributeMap, getSuccessValue

Constructor Detail

ProcessingResultSuccess

public ProcessingResultSuccess(String errorCode,
                               String errorMessage)

ProcessingResultSuccess

public ProcessingResultSuccess(String errorCode,
                               Throwable error)

ProcessingResultSuccess

public ProcessingResultSuccess(boolean success)

Method Detail

getPlaceholderValue

public String getPlaceholderValue(int index,
                                  String key)

Description copied from interface: IProcessingResult

In general, the result of an action is a List of Maps. This return the value at a given index and key.

Specified by:

getPlaceholderValue in interface IProcessingResult

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

public int getValuesCount()

Specified by:

getValuesCount in interface IProcessingResult

Returns:

The number of values the workflow action returned.

getErrorCode

public String getErrorCode()

Specified by:

getErrorCode in interface IProcessingResult

Returns:

the errorCode

setErrorCode

public void setErrorCode(String errorCode)

Parameters:

errorCode - the errorCode to set

getErrorMessage

public String getErrorMessage()

Specified by:

getErrorMessage in interface IProcessingResult

Returns:

the errorMessage

setErrorMessage

public void setErrorMessage(String errorMessage)

Parameters:

errorMessage - the errorMessage to set