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

Class ProcessingResultFileData

java.lang.Object

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

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

All Implemented Interfaces:

IPluginReturnValue, IPluginProcessingRetVal, IProcessingResult, IProcessingResultFileData

public class ProcessingResultFileData
extends AProcessingResult
implements IProcessingResultFileData

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor and Description
ProcessingResultFileData(String fileName, boolean forceDownload, byte[] fileContent)
ProcessingResultFileData(String fileName, boolean forceDownload, byte[] fileContent, boolean success)

Method Summary

Modifier and Type	Method and Description
byte[]	getFileContent() Getter for the binary content of the file
String	getFileName() Getter of the file name
boolean	getForceDownload() Getter if the file should returned as an forced download
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

ProcessingResultFileData

public ProcessingResultFileData(String fileName,
                                boolean forceDownload,
                                byte[] fileContent,
                                boolean success)

ProcessingResultFileData

public ProcessingResultFileData(String fileName,
                                boolean forceDownload,
                                byte[] fileContent)

Method Detail

getFileContent

public byte[] getFileContent()

Description copied from interface: IProcessingResultFileData

Getter for the binary content of the file

Specified by:

getFileContent in interface IProcessingResultFileData

Returns:

Byte-Array of the file content

getForceDownload

public boolean getForceDownload()

Description copied from interface: IProcessingResultFileData

Getter if the file should returned as an forced download

Specified by:

getForceDownload in interface IProcessingResultFileData

Returns:

Boolean if the download should be forced

getFileName

public String getFileName()

Description copied from interface: IProcessingResultFileData

Getter of the file name

Specified by:

getFileName in interface IProcessingResultFileData

Returns:

String the file name

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.