com.docdoku.server.importers

Interface PartImporter

public interface PartImporter

PartImporter plugin interface

Method Summary

Modifier and Type	Method and Description
boolean	canImportFile(String importFileName) Determine if plugin is able to import the given file format
ImportPreview	dryRunImport(String workspaceId, File file, String originalFileName, boolean autoCheckout, boolean autoCheckin, boolean permissiveUpdate) Run a dry import
ImportResult	importFile(String workspaceId, File file, String revisionNote, 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

ImportResult importFile(String workspaceId,
                        File file,
                        String revisionNote,
                        boolean autoCheckout,
                        boolean autoCheckin,
                        boolean permissiveUpdate)

Import the file and make requested changes

Parameters:

workspaceId - the workspace concerned by the import

file - the file to import

revisionNote - a revision note to apply on parts changed

autoCheckout - check out the part if not checked out

autoCheckin - check in the modified parts after operation

permissiveUpdate - todo

Returns:

an ImportResult result object

dryRunImport

ImportPreview dryRunImport(String workspaceId,
                           File file,
                           String originalFileName,
                           boolean autoCheckout,
                           boolean autoCheckin,
                           boolean permissiveUpdate)

Run a dry import

Parameters:

workspaceId - the workspace concerned by the import

file - the file to import

originalFileName - the original file name

autoCheckout - check out the part if not checked out

autoCheckin - check in the modified parts after operation

permissiveUpdate - todo

Returns:

an ImportPreview result object