org.electrocodeogram.cpc.imports.api.imports
Interface IImportTask

All Superinterfaces:

org.electrocodeogram.cpc.importexport.api.generic.IImportExportTask

public interface IImportTask
extends org.electrocodeogram.cpc.importexport.api.generic.IImportExportTask

This interface represents a complete description of an import task.
It includes all configuration options and data required by the IImportController implementation.

An IImportExportTask.setToolAdapter(org.electrocodeogram.cpc.importexport.api.generic.IGenericImportExportDescriptor) value needs to implement IImportToolAdapterDescriptor in order for this task to be valid.

A new instance can be obtained from IImportController.createTask().

Author:

vw

See Also:

IImportController, IImportExportTask

Method Summary

java.util.List<IImportFilterStrategyDescriptor>	getImportFilterStrategies() Retrieves a list of descriptors of all IImportFilterStrategys which should be applied to this import.
java.util.Map<IImportFilterStrategyDescriptor,java.util.Map<java.lang.String,java.lang.String>>	getImportFilterStrategyOptions() Retrieves configuration options for all IImportFilterStrategys.
boolean	isClearExistingClones() Whether existing clone data should be purged before processing the import.
void	setClearExistingClones(boolean clearExistingClones) Specifies whether existing clone data should be purged before processing the import.
void	setImportFilterStrategies(java.util.List<IImportFilterStrategyDescriptor> importFilterStrategies) Sets a list of descriptors of all IImportFilterStrategys which should be applied to this import.
void	setImportFilterStrategyOptions(java.util.Map<IImportFilterStrategyDescriptor,java.util.Map<java.lang.String,java.lang.String>> importFilterStrategyOptions) Sets the configuration options for all IImportFilterStrategys.

Methods inherited from interface org.electrocodeogram.cpc.importexport.api.generic.IImportExportTask

getProjects, getToolAdapter, getToolAdapterOptions, isValid, setProjects, setToolAdapter, setToolAdapterOptions

Method Detail

isClearExistingClones

boolean isClearExistingClones()

Whether existing clone data should be purged before processing the import.

Returns:

true if existing clone data should be deleted

setClearExistingClones

void setClearExistingClones(boolean clearExistingClones)

Specifies whether existing clone data should be purged before processing the import.

Parameters:

clearExistingClones - true if existing clone data should be deleted

getImportFilterStrategies

java.util.List<IImportFilterStrategyDescriptor> getImportFilterStrategies()

Retrieves a list of descriptors of all IImportFilterStrategys which should be applied to this import.
If this is null the default strategies will be applied.
If this is an empty list, no strategies will be applied.

Returns:

list of IImportFilterStrategyDescriptors, may be NULL.

setImportFilterStrategies

void setImportFilterStrategies(java.util.List<IImportFilterStrategyDescriptor> importFilterStrategies)

Sets a list of descriptors of all IImportFilterStrategys which should be applied to this import.

Parameters:

importFilterStrategies - a list of IImportFilterStrategyDescriptors, may be NULL.

See Also:

getImportFilterStrategies()

getImportFilterStrategyOptions

java.util.Map<IImportFilterStrategyDescriptor,java.util.Map<java.lang.String,java.lang.String>> getImportFilterStrategyOptions()

Retrieves configuration options for all IImportFilterStrategys.

Only IImportFilterStrategys which defined configuration options in their extension descriptor are guaranteed to be listed in the map.

If getImportFilterStrategies() is null, this value may also be null.

Returns:

a map which may contain configuration option maps for each IImportFilterStrategy, may be NULL.

setImportFilterStrategyOptions

void setImportFilterStrategyOptions(java.util.Map<IImportFilterStrategyDescriptor,java.util.Map<java.lang.String,java.lang.String>> importFilterStrategyOptions)

Sets the configuration options for all IImportFilterStrategys.

Parameters:

importFilterStrategyOptions - a map which may contain configuration option maps for each IImportFilterStrategy, may be NULL.