Package com.polarion.alm.tracker.exporter

Interface IExportManager

public interface IExportManager

Manages exporters and export templates, and executes exports. Exporters are contributable using plug-ins.

Author:

Jiri Banszel, POLARION SOFTWARE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXP_CSV	The Exporter Id that outputs a tree or table of Work Items to CSV.
static final String	EXP_EXCEL_MATRIX	The Exporter Id that outputs a matrix of Work Items and/or Revisions to an Excel table.
static final String	EXP_EXCEL_ROUND_TRIP	The exporter ID that outputs a module to an Excel round-trip document.
static final String	EXP_EXCEL_TRACEABILITY_REPORT	The Exporter Id that outputs a traceability report of Work Items and/or Revisions to an Excel table.
static final String	EXP_MSPROJECT	The Exporter Id that output Work Items to an MS Project.
static final String	EXP_WORD_ROUND_TRIP	The Exporter Id that outputs a module to a Word round-trip document.
static final String	EXP_XML_HTML	The Exporter Id that outputs a table of Work Items to HTML.
static final String	EXP_XML_PDF	The Exporter Id that outputs a table of Work Items to PDF.
static final String	EXP_XML_RTF	The Exporter Id that outputs a table of Work Items to RTF.
static final String	EXP_XML_TXT	The Exporter Id that outputs a table of Work Items to TXT.
static final String	EXP_XML_XML	The Exporter Id that outputs a table of Work Items to XML.

Method Summary

Modifier and Type	Method	Description
IExportTemplate	createTemplate(IExporterDescriptor exporterDescriptor, String templateName, InputStream content)	Deprecated. use setTemplateContent(IExporterDescriptor, String, IContextId, InputStream, boolean)
void	deleteTemplate(IExporterDescriptor exporterDescriptor, String templateName)	Deprecated.
void	deleteTemplate(IExporterDescriptor exporterDescriptor, String templateName, IContextId contextId)
IExport	getExport(String exportId)	Returns an export with a given id or null if it is not found.
IExporterDescriptor	getExporterDescriptor(String id)	Returns the descriptor with a given id.
Collection<IExporterDescriptor>	getExporterDescriptors()	Deprecated. use getExporterDescriptor(String)
Collection<IExporterDescriptor>	getExporterDescriptors(String exportType)	Returns descriptors of all registered exporters (sorted lexicographically by label) that support the export type (see EXPORT_TYPE constants in subinterfaces of IExportConfiguration.
List<IExport>	getExports(IUser user)	Returns all exports started by a user (newer exports first), that have yet to be removed.
IExportTemplate	getTemplate(IExporterDescriptor exporterDescriptor, String templateName)	Deprecated. use getTemplate(IExporterDescriptor, String, IContextId)
IExportTemplate	getTemplate(IExporterDescriptor exporterDescriptor, String templateName, IContextId contextId)	Returns a template with given name or null if such a template does not exist.
IExportTemplateFactory	getTemplateFactory(String exporterId)	Returns a factory for exporter templates.
Collection<IExportTemplate>	getTemplates(IExporterDescriptor exporterDescriptor)	Deprecated. use getTemplates(IExporterDescriptor, IContextId)
List<IExportTemplate>	getTemplates(IExporterDescriptor exporterDescriptor, IContextId contextId)	Returns templates available for export with a given exporter (sorted lexicographically by name) in given a context.
void	removeExport(IExport export)	Removes a completed export.
IExportTemplate	setTemplateContent(IExporterDescriptor exporterDescriptor, String templateName, IContextId contextId, InputStream content, boolean overwrite)	Creates or updates a template.
IExport	startExport(IExporterDescriptor exporterDescriptor, IExportConfiguration config)	Starts the export.

Field Details

EXP_MSPROJECT

static final String EXP_MSPROJECT

The Exporter Id that output Work Items to an MS Project.

See Also:

• Constant Field Values

EXP_CSV

static final String EXP_CSV

The Exporter Id that outputs a tree or table of Work Items to CSV.

See Also:

• Constant Field Values

EXP_EXCEL_MATRIX

static final String EXP_EXCEL_MATRIX

The Exporter Id that outputs a matrix of Work Items and/or Revisions to an Excel table.

See Also:

• Constant Field Values

EXP_EXCEL_TRACEABILITY_REPORT

static final String EXP_EXCEL_TRACEABILITY_REPORT

The Exporter Id that outputs a traceability report of Work Items and/or Revisions to an Excel table.

See Also:

• Constant Field Values

EXP_XML_XML

static final String EXP_XML_XML

The Exporter Id that outputs a table of Work Items to XML.

Since:

3.3

See Also:

• Constant Field Values

EXP_XML_HTML

static final String EXP_XML_HTML

The Exporter Id that outputs a table of Work Items to HTML.

Since:

3.3

See Also:

• Constant Field Values

EXP_XML_TXT

static final String EXP_XML_TXT

The Exporter Id that outputs a table of Work Items to TXT.

Since:

3.3

See Also:

• Constant Field Values

EXP_XML_PDF

static final String EXP_XML_PDF

The Exporter Id that outputs a table of Work Items to PDF.

Since:

3.3

See Also:

• Constant Field Values

EXP_XML_RTF

static final String EXP_XML_RTF

The Exporter Id that outputs a table of Work Items to RTF.

Since:

3.3

See Also:

• Constant Field Values

EXP_WORD_ROUND_TRIP

static final String EXP_WORD_ROUND_TRIP

The Exporter Id that outputs a module to a Word round-trip document.

Since:

3.5

See Also:

• Constant Field Values

EXP_EXCEL_ROUND_TRIP

static final String EXP_EXCEL_ROUND_TRIP

The exporter ID that outputs a module to an Excel round-trip document.

Since:

3.5.1

See Also:

• Constant Field Values

Method Details

getExporterDescriptors

Collection<IExporterDescriptor> getExporterDescriptors(String exportType)

Returns descriptors of all registered exporters (sorted lexicographically by label) that support the export type (see EXPORT_TYPE constants in subinterfaces of IExportConfiguration.

Returns:

the IExporterDescriptor collection.

getExporterDescriptor

IExporterDescriptor getExporterDescriptor(String id)

Returns the descriptor with a given id.

Returns:

IExportDescriptor with the given id or null if it does not exist.

startExport

IExport startExport(IExporterDescriptor exporterDescriptor,
 IExportConfiguration config)

Starts the export.

Parameters:

exporterDescriptor -

config -

See Also:

• IExport.isFinished()
• IExport.isSuccessful()
• IExport.getResult()

removeExport

void removeExport(IExport export)

Removes a completed export.

Parameters:

export -

Throws:

IllegalArgumentException - if the export has not completed.

getExports

List<IExport> getExports(IUser user)

Returns all exports started by a user (newer exports first), that have yet to be removed. If user is null, all exports are returned.

Returns:

a list of IExport.

getExport

IExport getExport(String exportId)

Returns an export with a given id or null if it is not found.

Parameters:

exportId -

getTemplates

List<IExportTemplate> getTemplates(IExporterDescriptor exporterDescriptor,
 IContextId contextId)

Returns templates available for export with a given exporter (sorted lexicographically by name) in given a context. (Templates inherited from other contexts are included.)

Parameters:

exporterDescriptor -

contextId -

Returns:

a list of templates.

Throws:

IllegalArgumentException - if the exporter does not support templates.

Since:

3.5.1

See Also:

• IExporterDescriptor.isTemplateExporter()

getTemplate

IExportTemplate getTemplate(IExporterDescriptor exporterDescriptor,
 String templateName,
 IContextId contextId)

Returns a template with given name or null if such a template does not exist.

Parameters:

exporterDescriptor -

templateName -

contextId -

Returns:

IExportTemplate

Throws:

IllegalArgumentException - if the exporter does not support templates.

Since:

3.5.1

See Also:

• IExporterDescriptor.isTemplateExporter()

setTemplateContent

IExportTemplate setTemplateContent(IExporterDescriptor exporterDescriptor,
 String templateName,
 IContextId contextId,
 InputStream content,
 boolean overwrite)

Creates or updates a template.

Parameters:

exporterDescriptor -

templateName -

contextId -

content -

overwrite -

Returns:

the IExportTemplate for the specified parameters.

Throws:

IllegalArgumentException - if the exporter does not support templates.

Since:

3.5.1

See Also:

• IExporterDescriptor.isTemplateExporter()

deleteTemplate

void deleteTemplate(IExporterDescriptor exporterDescriptor,
 String templateName,
 IContextId contextId)

Parameters:

exporterDescriptor -

templateName -

contextId -

Throws:

IllegalArgumentException - if the exporter does not support templates.

Since:

3.5.1

See Also:

• IExporterDescriptor.isTemplateExporter()

getTemplateFactory

@NotNull
IExportTemplateFactory getTemplateFactory(@NotNull
 String exporterId)

Returns a factory for exporter templates.

Throws:

IllegalArgumentException - if the exporter does not exist or does not support templates.

Since:

3.17.1

getTemplates

@Deprecated
Collection<IExportTemplate> getTemplates(IExporterDescriptor exporterDescriptor)

Deprecated.

use getTemplates(IExporterDescriptor, IContextId)

Parameters:

exporterDescriptor -

Returns:

a collection of templates.

getTemplate

@Deprecated
IExportTemplate getTemplate(IExporterDescriptor exporterDescriptor,
 String templateName)

Deprecated.

use getTemplate(IExporterDescriptor, String, IContextId)

Parameters:

exporterDescriptor -

templateName -

Returns:

an export template.

createTemplate

@Deprecated
IExportTemplate createTemplate(IExporterDescriptor exporterDescriptor,
 String templateName,
 InputStream content)

Deprecated.

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

Parameters:

exporterDescriptor -

templateName -

content -

Returns:

the template.

deleteTemplate

@Deprecated
void deleteTemplate(IExporterDescriptor exporterDescriptor,
 String templateName)

Deprecated.

Parameters:

exporterDescriptor -

templateName -

getExporterDescriptors

@Deprecated
Collection<IExporterDescriptor> getExporterDescriptors()

Deprecated.

use getExporterDescriptor(String)

Returns descriptors of all registered exporters (sorted lexicographically by label) that support the tree or table export types.

Returns:

a collection of IExporterDescriptor