org.bonitasoft.engine.bpm.bar

Class ResourceInSpecificFolderContribution

java.lang.Object

org.bonitasoft.engine.bpm.bar.ResourceInSpecificFolderContribution

All Implemented Interfaces:

BusinessArchiveContribution

Direct Known Subclasses:

ClasspathContribution, ConnectorContribution, DocumentsResourcesContribution, UserFilterContribution

public abstract class ResourceInSpecificFolderContribution
extends Object
implements BusinessArchiveContribution

Author:

Baptiste Mesta, Celine Souchet

Constructor Summary

Constructors

Constructor and Description
ResourceInSpecificFolderContribution()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract String	getFolderName()
boolean	isMandatory() Checks if this BusinessArchiveContribution is mandatory
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

Constructor Detail

ResourceInSpecificFolderContribution

public ResourceInSpecificFolderContribution()

Method Detail

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

getFolderName

protected abstract String getFolderName()

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.

isMandatory

public boolean isMandatory()

Description copied from interface: BusinessArchiveContribution

Checks if this BusinessArchiveContribution is mandatory

Specified by:

isMandatory in interface BusinessArchiveContribution

Returns:

true if this BusinessArchiveContribution is mandatory; false otherwise