org.electrocodeogram.cpc.exports.api.exports.adapter
Interface IExportToolAdapterTask

All Superinterfaces:
org.electrocodeogram.cpc.importexport.api.generic.IImportExportToolAdapterTask

public interface IExportToolAdapterTask
extends org.electrocodeogram.cpc.importexport.api.generic.IImportExportToolAdapterTask

Configuration data collection object for the IExportToolAdapter.

NOTE: the clone data itself is not part of the export task description. The export tool adapter needs to fetch the data from the provided store provider instance. The main rationale for this is that it might not always be possible to load all clone data into memory. By providing a store provider instance an export tool adapter can process the clone data file by file.

NOTE: The caller of an IExportToolAdapter does not hold a lock on the store provider.

Author:
vw

Method Summary
 IStoreProvider getStoreProvider()
          Retrieves the IStoreProvider instance which should be used to obtain the clone data for the files which were selected for this export.
 void setStoreProvider(IStoreProvider storeProvider)
          Sets the IStoreProvider instance which should be used to obtain the clone data for the files which were selected for this export.
 
Methods inherited from interface org.electrocodeogram.cpc.importexport.api.generic.IImportExportToolAdapterTask
getFiles, getOptions, isValid, setFiles, setOptions
 

Method Detail

getStoreProvider

IStoreProvider getStoreProvider()
Retrieves the IStoreProvider instance which should be used to obtain the clone data for the files which were selected for this export.

NOTE: The caller of an IExportToolAdapter does not hold a lock on the store provider.

Returns:
valid IStoreProvider reference, never null.

setStoreProvider

void setStoreProvider(IStoreProvider storeProvider)
Sets the IStoreProvider instance which should be used to obtain the clone data for the files which were selected for this export.

Parameters:
storeProvider - valid IStoreProvider reference, never null.