Package com.polarion.alm.tracker.exporter

Class TreeExportConfiguration

java.lang.Object

com.polarion.alm.tracker.exporter.ExportConfiguration

com.polarion.alm.tracker.exporter.TreeExportConfiguration

All Implemented Interfaces:

IExportConfiguration, ITreeExportConfiguration

public class TreeExportConfiguration
extends ExportConfiguration
implements ITreeExportConfiguration

Author:

Jiri Banszel, POLARION SOFTWARE

Nested Class Summary

Nested classes/interfaces inherited from interface com.polarion.alm.tracker.exporter.IExportConfiguration

IExportConfiguration.IExportField

Field Summary

Fields inherited from interface com.polarion.alm.tracker.exporter.ITreeExportConfiguration

EXPORT_TYPE

Constructor Summary

Constructors

Constructor	Description
TreeExportConfiguration(IPObjectTree tree, String query, String charset, List fields, IExportTemplate template, Map params)

Method Summary

Modifier and Type	Method	Description
String	getQuery()	Query used to obtain the Work Items, or null.
IPObjectList	getWorkItems()	Deprecated.
IPObjectTree	getWorkItemTree()	Returns tree of Work Items to export.

Methods inherited from class com.polarion.alm.tracker.exporter.ExportConfiguration

getCharset, getContextId, getExportFields, getFields, getModule, getParameter, getTemplate, setContextId, setModule, setTemplate

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.polarion.alm.tracker.exporter.IExportConfiguration

getCharset, getContextId, getExportFields, getFields, getModule, getParameter, getTemplate

Constructor Details

TreeExportConfiguration

public TreeExportConfiguration(IPObjectTree tree,
 String query,
 String charset,
 List fields,
 IExportTemplate template,
 Map params)

Parameters:

tree - must not be null

query -

charset -

fields - either a list of field ids, or a list of IExportConfiguration.IExportField

template -

params -

Method Details

getQuery

public String getQuery()

Description copied from interface: ITreeExportConfiguration

Query used to obtain the Work Items, or null.

Specified by:

getQuery in interface IExportConfiguration

Specified by:

getQuery in interface ITreeExportConfiguration

Overrides:

getQuery in class ExportConfiguration

Returns:

The query used.

getWorkItemTree

public IPObjectTree getWorkItemTree()

Description copied from interface: ITreeExportConfiguration

Returns tree of Work Items to export.

Specified by:

getWorkItemTree in interface IExportConfiguration

Specified by:

getWorkItemTree in interface ITreeExportConfiguration

Overrides:

getWorkItemTree in class ExportConfiguration

Returns:

A tree of Work Items to export.

See Also:

• IExportConfiguration.getWorkItems()

getWorkItems

@Deprecated
public IPObjectList getWorkItems()

Deprecated.

Description copied from interface: IExportConfiguration

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.

Specified by:

getWorkItems in interface IExportConfiguration

Overrides:

getWorkItems in class ExportConfiguration

Returns:

The list of IWorkItems, never null.

See Also:

• IExportConfiguration.getWorkItemTree()