org.bonitasoft.engine.bpm.bar

Class ExternalResourceContribution

java.lang.Object

org.bonitasoft.engine.bpm.bar.ExternalResourceContribution

All Implemented Interfaces:

BusinessArchiveContribution

public class ExternalResourceContribution
extends Object
implements BusinessArchiveContribution

Deals with the external resources in a BusinessArchive. Is considered external a resource that is not managed by the Bonita Engine.

Author:

Emmanuel Duchastenier, Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL_RESOURCE_FOLDER

Constructor Summary

Constructors

Constructor and Description
ExternalResourceContribution()

Method Summary

Modifier and Type	Method and Description
String	getName() Retrieves the BusinessArchiveContribution name
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

Field Detail

EXTERNAL_RESOURCE_FOLDER

public static final String EXTERNAL_RESOURCE_FOLDER

See Also:

Constant Field Values

Constructor Detail

ExternalResourceContribution

public ExternalResourceContribution()

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

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

getName

public String getName()

Description copied from interface: BusinessArchiveContribution

Retrieves the BusinessArchiveContribution name

Specified by:

getName in interface BusinessArchiveContribution

Returns:

the BusinessArchiveContribution name