org.bonitasoft.engine.bpm.bar

Class GenericFileContribution

java.lang.Object

org.bonitasoft.engine.bpm.bar.GenericFileContribution

All Implemented Interfaces:

BusinessArchiveContribution

Direct Known Subclasses:

ActorMappingContribution

public abstract class GenericFileContribution
extends Object
implements BusinessArchiveContribution

Author:

Emmanuel Duchastenier, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
GenericFileContribution()

Method Summary

Methods

Modifier and Type	Method and Description
abstract String	getFileName()
boolean	readFromBarFolder(BusinessArchive businessArchive, File barFolder) Updates the BusinessArchive with information read from the file system and returns true if the information was successfully read or false otherwise.
void	saveToBarFolder(BusinessArchive businessArchive, File barFolder) Writes the content of the BusinessArchive to the file system

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.bonitasoft.engine.bpm.bar.BusinessArchiveContribution

getName, isMandatory

Constructor Detail

GenericFileContribution

public GenericFileContribution()

Method Detail

getFileName

public abstract String getFileName()

readFromBarFolder

public boolean readFromBarFolder(BusinessArchive businessArchive,
                        File barFolder)
                          throws IOException

Description copied from interface: BusinessArchiveContribution

Updates the BusinessArchive with information read from the file system and returns true if the information was successfully read or false otherwise.

Specified by:

readFromBarFolder in interface BusinessArchiveContribution

Parameters:

businessArchive - the BusinessArchive to be filled with information read from the file system

barFolder - the folder storing the information to be filled in the BusinessArchive

Returns:

true if the information was successfully read from file system; false otherwise.

Throws:

IOException - if a problem occurs when reading information from file system.

See Also:

BusinessArchive

saveToBarFolder

public void saveToBarFolder(BusinessArchive businessArchive,
                   File barFolder)
                     throws IOException

Description copied from interface: BusinessArchiveContribution

Writes the content of the BusinessArchive to the file system

Specified by:

saveToBarFolder in interface BusinessArchiveContribution

Parameters:

businessArchive - the BusinessArchive containing the information to be stored in the file system

barFolder - the folder where the BusinessArchive information will be stored.

Throws:

IOException - when a problem occurs when the information is being stored in the file system.