Package com.polarion.alm.tracker.importer

Interface IImportManager

public interface IImportManager

Manages importers and import templates, and executes imports. Importers are contributable using deployment.

Author:

Jiri Banszel, POLARION SOFTWARE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IMP_EXCEL
static final String	IMP_EXCEL_ROUND_TRIP
static final String	IMP_MSPROJECT	Id of importer from MS Project XML file.
static final String	IMP_WORD	Id of importer from Word document.
static final String	IMP_WORD_ROUND_TRIP	Id of importer from Word round-trip document.

Method Summary

Modifier and Type	Method	Description
IImportTemplate	createTemplate(IImporterDescriptor importerDescriptor, String templateName, InputStream content)	Deprecated. use setTemplateContent(IImporterDescriptor, String, IContextId, InputStream, boolean)
void	deleteTemplate(IImporterDescriptor importerDescriptor, String templateName)	Deprecated. use deleteTemplate(IImporterDescriptor, String, IContextId)
void	deleteTemplate(IImporterDescriptor importerDescriptor, String templateName, IContextId contextId)
IImportInfo	getImport(String importId)	Returns import info by id or null if it is not found.
IImporterDescriptor	getImporterDescriptor(String id)	Returns descriptor with the given id.
Collection<IImporterDescriptor>	getImporterDescriptors()	Returns descriptors of all registered importers (sorted lexicographically by label).
List<IImporterDescriptor>	getImporterDescriptors(String importType)	Returns descriptors of all registered importers (sorted lexicographically by label) that supports the export type (see EXPORT_TYPE* constants in IImportConfiguration and its sub-interfaces.
List<IImportInfo>	getImports(IUser user)	Returns all imports started by the user (newer imports first), that were not removed yet.
IImportTemplate	getTemplate(IImporterDescriptor importerDescriptor, String templateName)	Deprecated. use getTemplate(IImporterDescriptor, String, IContextId)
IImportTemplate	getTemplate(IImporterDescriptor importerDescriptor, String templateName, IContextId contextId)	Returns template with the given name or null if such a template does not exist (not even inherited one).
Collection<IImportTemplate>	getTemplates(IImporterDescriptor importerDescriptor)	Deprecated. use getTemplates(IImporterDescriptor, IContextId)
Collection<IImportTemplate>	getTemplates(IImporterDescriptor importerDescriptor, IContextId contextId)	Returns templates available for import with the given importer (sorted lexicographically by name) in the given context (so the returned list of templates contains templates inherited from other contexts).
void	removeImportInfo(IImportInfo importInfo)	Removes finished import info.
IImportTemplate	setTemplateContent(IImporterDescriptor importerDescriptor, String templateName, IContextId contextId, InputStream content, boolean overwrite)	Creates or updates a template.
IImportInfo	startImport(IImporterDescriptor importerDescriptor, IImportConfiguration config)	Starts the import.

Field Details

IMP_MSPROJECT

static final String IMP_MSPROJECT

Id of importer from MS Project XML file.

See Also:

• Constant Field Values

IMP_WORD

static final String IMP_WORD

Id of importer from Word document.

Since:

3.5.0

See Also:

• Constant Field Values

IMP_WORD_ROUND_TRIP

static final String IMP_WORD_ROUND_TRIP

Id of importer from Word round-trip document.

Since:

3.5.0

See Also:

• Constant Field Values

IMP_EXCEL_ROUND_TRIP

static final String IMP_EXCEL_ROUND_TRIP

Since:

3.5.1

See Also:

• Constant Field Values

IMP_EXCEL

static final String IMP_EXCEL

Since:

3.5.2

See Also:

• Constant Field Values

Method Details

getImporterDescriptors

Collection<IImporterDescriptor> getImporterDescriptors()

Returns descriptors of all registered importers (sorted lexicographically by label).

Returns:

collection of IImporterDescriptor

getImporterDescriptors

List<IImporterDescriptor> getImporterDescriptors(String importType)

Returns descriptors of all registered importers (sorted lexicographically by label) that supports the export type (see EXPORT_TYPE* constants in IImportConfiguration and its sub-interfaces.

Parameters:

importType -

Returns:

collection of IImporterDescriptor

Since:

3.5.0

getImporterDescriptor

IImporterDescriptor getImporterDescriptor(String id)

Returns descriptor with the given id.

Parameters:

id -

Returns:

the ImportDescriptor for the given id or null if it does not exist

startImport

IImportInfo startImport(IImporterDescriptor importerDescriptor,
 IImportConfiguration config)

Starts the import.

Parameters:

importerDescriptor -

config -

Returns:

import info

See Also:

• IImportInfo.isFinished()
• IImportInfo.isSuccessful()

removeImportInfo

void removeImportInfo(IImportInfo importInfo)

Removes finished import info.

Parameters:

importInfo -

Throws:

IllegalArgumentException - if the import is not finished yet

getImports

List<IImportInfo> getImports(IUser user)

Returns all imports started by the user (newer imports first), that were not removed yet. If user is null, all imports are returned.

Returns:

list of IImportInfo

getImport

IImportInfo getImport(String importId)

Returns import info by id or null if it is not found.

Parameters:

importId -

getTemplates

@Deprecated
Collection<IImportTemplate> getTemplates(IImporterDescriptor importerDescriptor)

Deprecated.

use getTemplates(IImporterDescriptor, IContextId)

getTemplates

Collection<IImportTemplate> getTemplates(IImporterDescriptor importerDescriptor,
 IContextId contextId)

Returns templates available for import with the given importer (sorted lexicographically by name) in the given context (so the returned list of templates contains templates inherited from other contexts).

Parameters:

importerDescriptor -

contextId -

Returns:

collection of IImportTemplate

Throws:

IllegalArgumentException - if the importer does not support templates

Since:

3.5.0

See Also:

• IImporterDescriptor.isTemplateImporter()

getTemplate

@Deprecated
IImportTemplate getTemplate(IImporterDescriptor importerDescriptor,
 String templateName)

Deprecated.

use getTemplate(IImporterDescriptor, String, IContextId)

getTemplate

IImportTemplate getTemplate(IImporterDescriptor importerDescriptor,
 String templateName,
 IContextId contextId)

Returns template with the given name or null if such a template does not exist (not even inherited one).

Parameters:

importerDescriptor -

templateName -

contextId -

Returns:

IImportTemplate

Throws:

IllegalArgumentException - if the importer does not support templates

Since:

3.5.0

See Also:

• IImporterDescriptor.isTemplateImporter()

createTemplate

@Deprecated
IImportTemplate createTemplate(IImporterDescriptor importerDescriptor,
 String templateName,
 InputStream content)

Deprecated.

use setTemplateContent(IImporterDescriptor, String, IContextId, InputStream, boolean)

Parameters:

importerDescriptor -

templateName -

content -

Throws:

IllegalArgumentException - if the importer does not support templates

See Also:

• IImporterDescriptor.isTemplateImporter()

setTemplateContent

IImportTemplate setTemplateContent(IImporterDescriptor importerDescriptor,
 String templateName,
 IContextId contextId,
 InputStream content,
 boolean overwrite)

Creates or updates a template.

Parameters:

importerDescriptor -

templateName -

content -

Throws:

IllegalArgumentException - if the importer does not support templates

Since:

3.5.0

See Also:

• IImporterDescriptor.isTemplateImporter()

deleteTemplate

@Deprecated
void deleteTemplate(IImporterDescriptor importerDescriptor,
 String templateName)

Deprecated.

use deleteTemplate(IImporterDescriptor, String, IContextId)

deleteTemplate

void deleteTemplate(IImporterDescriptor importerDescriptor,
 String templateName,
 IContextId contextId)

Parameters:

importerDescriptor -

templateName -

contextId -

Throws:

IllegalArgumentException - if the importer does not support templates

Since:

3.5.0

See Also:

• IImporterDescriptor.isTemplateImporter()