Package com.polarion.alm.tracker.exporter

Interface IExportConfiguration

All Known Subinterfaces:

IMatrixExportConfiguration, IModuleExportConfiguration, ITableExportConfiguration, ITreeExportConfiguration

All Known Implementing Classes:

ExportConfiguration, MatrixExportConfiguration, ModuleExportConfiguration, TableExportConfiguration, TreeExportConfiguration

public interface IExportConfiguration

Author:

Jiri Banszel, POLARION SOFTWARE

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IExportConfiguration.IExportField

Method Summary

Modifier and Type	Method	Description
String	getCharset()
IContextId	getContextId()
List<IExportConfiguration.IExportField>	getExportFields()
List	getFields()	Deprecated.
IModule	getModule()	Returns the module in the context that the export was invoked for.
Object	getParameter(String id)
String	getQuery()	Deprecated. use ITableExportConfiguration.getQuery() or ITreeExportConfiguration.getQuery()
IExportTemplate	getTemplate()
IPObjectList	getWorkItems()	Deprecated. use ITableExportConfiguration.getWorkItems()
IPObjectTree	getWorkItemTree()	Deprecated. use ITreeExportConfiguration.getWorkItemTree()

Method Details

getContextId

IContextId getContextId()

Returns:

The context where export was invoked.

Since:

3.5.1

getModule

IModule getModule()

Returns the module in the context that the export was invoked for.

Returns:

module or null

Since:

3.5.2

getCharset

String getCharset()

getTemplate

@Nullable
IExportTemplate getTemplate()

getExportFields

List<IExportConfiguration.IExportField> getExportFields()

Returns:

Fields to export.

Since:

3.5.2

getParameter

Object getParameter(String id)

getFields

@Deprecated
List getFields()

Deprecated.

Returns:

The list of field IDs.

getWorkItemTree

@Deprecated
IPObjectTree getWorkItemTree()

Deprecated.

use ITreeExportConfiguration.getWorkItemTree()

Returns:

A tree of Work Items to export.

See Also:

• getWorkItems()

getWorkItems

@Deprecated
IPObjectList getWorkItems()

Deprecated.

use ITableExportConfiguration.getWorkItems()

Returns Work Items in the first level of the tree. This is a convenient method for exporters that cannot export a tree. A single level tree is always passed to them so that this method only returns the list of Work Items to export.

Returns:

The list of IWorkItems, never null.

See Also:

• getWorkItemTree()

getQuery

@Deprecated
String getQuery()

Deprecated.

use ITableExportConfiguration.getQuery() or ITreeExportConfiguration.getQuery()

Returns:

The query used.