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

Class ProcessingResultFilePath

java.lang.Object

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

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

All Implemented Interfaces:

IPluginReturnValue, IPluginProcessingRetVal, IProcessingResult, IProcessingResultFilePath

public class ProcessingResultFilePath
extends AProcessingResult
implements IProcessingResultFilePath

Constructor Summary

Constructors

Constructor and Description
ProcessingResultFilePath(File file)
ProcessingResultFilePath(File file, boolean success)
ProcessingResultFilePath(String filePath)
ProcessingResultFilePath(String filePath, boolean success)

Method Summary

Modifier and Type	Method and Description
String	getFilePath() Getter of the file path
String	getPlaceholderValue(int index, String key) In general, the result of an action is a List of Maps.
int	getValuesCount()

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

getErrorCode, getErrorMessage, getSessionAttributeMap, getSuccessValue

Constructor Detail

ProcessingResultFilePath

public ProcessingResultFilePath(String filePath,
                                boolean success)

ProcessingResultFilePath

public ProcessingResultFilePath(String filePath)

ProcessingResultFilePath

public ProcessingResultFilePath(File file,
                                boolean success)

ProcessingResultFilePath

public ProcessingResultFilePath(File file)

Method Detail

getFilePath

public String getFilePath()

Description copied from interface: IProcessingResultFilePath

Getter of the file path

Specified by:

getFilePath in interface IProcessingResultFilePath

Returns:

String the file path

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.