org.electrocodeogram.cpc.exports.api.exports
Interface IExportController


public interface IExportController

Main backend controller for the CPC Exports module.
Can be used to execute clone data exports via registered IExportToolAdapters.

An instance can be obtained via CPCExportsPlugin.getExportController().

Author:
vw
See Also:
IExportToolAdapter

Method Summary
 IExportTask createTask()
          Creates a new empty IExportTask object which can then be filled with the task configuration options and data.
 org.electrocodeogram.cpc.importexport.api.generic.IGenericStatus executeExport(org.eclipse.core.runtime.IProgressMonitor monitor, IExportTask exportTask)
          Executes the complete export process using the IExportToolAdapter which corresponds to the given IExportToolAdapterDescriptor.
 java.util.List<IExportToolAdapterDescriptor> getRegisteredExportToolAdapters()
          Retrieves a list of all currently registered IExportToolAdapter implementations.
 

Method Detail

getRegisteredExportToolAdapters

java.util.List<IExportToolAdapterDescriptor> getRegisteredExportToolAdapters()
Retrieves a list of all currently registered IExportToolAdapter implementations.

Returns:
list of all registered IExportToolAdapter implementations, never null.

createTask

IExportTask createTask()
Creates a new empty IExportTask object which can then be filled with the task configuration options and data.
Once filled, the object can be passed to executeExport(IProgressMonitor, IExportTask) to execute the export task.

Returns:
an empty task object, never null.

executeExport

org.electrocodeogram.cpc.importexport.api.generic.IGenericStatus executeExport(org.eclipse.core.runtime.IProgressMonitor monitor,
                                                                               IExportTask exportTask)
                                                                               throws org.electrocodeogram.cpc.importexport.api.generic.ImportExportConfigurationOptionException,
                                                                                      org.electrocodeogram.cpc.importexport.api.generic.ImportExportFailureException,
                                                                                      java.lang.InterruptedException
Executes the complete export process using the IExportToolAdapter which corresponds to the given IExportToolAdapterDescriptor.

Export Process:

Parameters:
monitor - a progress monitor for progress reporting and cancellation, may be NULL.
exportTask - the export task to process, never null.
Returns:
clone export statistics, never null.
Throws:
org.electrocodeogram.cpc.importexport.api.generic.ImportExportConfigurationOptionException - if the given configuration options are illegal.
org.electrocodeogram.cpc.importexport.api.generic.ImportExportFailureException - if any error occurred during the export process.
java.lang.InterruptedException - if the import was cancelled by the user.