org.bonitasoft.engine.bpm.bar

Interface BusinessArchiveContribution

All Known Implementing Classes:

ActorMappingContribution, ClasspathContribution, ConnectorContribution, DocumentsResourcesContribution, ExternalResourceContribution, FormMappingContribution, GenericFileContribution, ParameterContribution, ProcessDefinitionBARContribution, ProcessDefinitionBARContributionExt, ResourceInSpecificFolderContribution, UserFilterContribution

public interface BusinessArchiveContribution

Supplies a specif information to the BusinessArchive. It's able to read/write information from/to the file system.

Author:

Baptiste Mesta

See Also:

BusinessArchive

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

Method Detail

readFromBarFolder

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

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

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.

InvalidBusinessArchiveFormatException - when the folder from which the information is being read has an invalid format.

See Also:

BusinessArchive

saveToBarFolder

void saveToBarFolder(BusinessArchive businessArchive,
                     File barFolder)
              throws IOException

Writes the content of the BusinessArchive to the file system

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

boolean isMandatory()

Checks if this BusinessArchiveContribution is mandatory

Returns:

true if this BusinessArchiveContribution is mandatory; false otherwise

getName

String getName()

Retrieves the BusinessArchiveContribution name

Returns:

the BusinessArchiveContribution name