org.polarsys.eplmp.server.importers

Interface BomImporter

public interface BomImporter

BomImporter plugin interface

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BomImporter.ImporterException Exception reporting a unrecoverable problem during conversion process.

Method Summary

Modifier and Type	Method and Description
boolean	canImportFile(String importFileName) Determine if plugin is able to import the given file format
BomImporterResult	importFile(Locale locale, String workspaceId, File file, boolean autoCheckout, boolean autoCheckIn, boolean permissiveUpdate) Import the file and make requested changes

Method Detail

canImportFile

boolean canImportFile(String importFileName)

Determine if plugin is able to import the given file format

Parameters:

importFileName - the file name

Returns:

true if plugin can handle the import, false otherwise

importFile

BomImporterResult importFile(Locale locale,
                             String workspaceId,
                             File file,
                             boolean autoCheckout,
                             boolean autoCheckIn,
                             boolean permissiveUpdate)
                      throws BomImporter.ImporterException

Import the file and make requested changes

Parameters:

workspaceId - the workspace concerned by the import

file - the file to import

autoCheckout - check out the part if not checked out

autoCheckIn - check in the modified parts after operation

permissiveUpdate - don't throw if any warnings or errors

Returns:

an ImportResult result object

Throws:

BomImporter.ImporterException