Package com.polarion.alm.tracker.exporter

Class ExportConfiguration

java.lang.Object

com.polarion.alm.tracker.exporter.ExportConfiguration

All Implemented Interfaces:

IExportConfiguration

Direct Known Subclasses:

MatrixExportConfiguration, ModuleExportConfiguration, TableExportConfiguration, TreeExportConfiguration

public class ExportConfiguration
extends Object
implements IExportConfiguration

Implementation of IExportConfiguration suitable for simple exports and for subclassing.

Author:

Jiri Banszel, POLARION SOFTWARE

Nested Class Summary

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

IExportConfiguration.IExportField

Constructor Summary

Constructors

Constructor	Description
ExportConfiguration(IPObjectTree tree, String query, String charset, List fields, IExportTemplate template, Map params)	Deprecated. use TreeExportConfiguration
ExportConfiguration(IPObjectList workItems, String query, String charset, List fields, IExportTemplate template, Map params)	Deprecated. use TableExportConfiguration

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ExportConfiguration

@Deprecated
public ExportConfiguration(IPObjectTree tree,
 String query,
 String charset,
 List fields,
 IExportTemplate template,
 Map params)

Deprecated.

use TreeExportConfiguration

ExportConfiguration

@Deprecated
public ExportConfiguration(IPObjectList workItems,
 String query,
 String charset,
 List fields,
 IExportTemplate template,
 Map params)

Deprecated.

use TableExportConfiguration

Method Details

setContextId

public void setContextId(IContextId contextId)

Parameters:

contextId -

Since:

3.5.1

getContextId

public IContextId getContextId()

Specified by:

getContextId in interface IExportConfiguration

Returns:

The context where export was invoked.

Since:

3.5.1

setModule

public void setModule(IModule module)

Parameters:

module -

Since:

3.5.2

getModule

public IModule getModule()

Description copied from interface: IExportConfiguration

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

Specified by:

getModule in interface IExportConfiguration

Returns:

module or null

Since:

3.5.2

getCharset

public String getCharset()

Specified by:

getCharset in interface IExportConfiguration

getExportFields

public List<IExportConfiguration.IExportField> getExportFields()

Specified by:

getExportFields in interface IExportConfiguration

Returns:

Fields to export.

Since:

3.5.2

getFields

public List getFields()

Specified by:

getFields in interface IExportConfiguration

Returns:

The list of field IDs.

getTemplate

public IExportTemplate getTemplate()

Specified by:

getTemplate in interface IExportConfiguration

setTemplate

public void setTemplate(@Nullable
 IExportTemplate template)

Since:

3.17.1

getParameter

public Object getParameter(String id)

Specified by:

getParameter in interface IExportConfiguration

getWorkItemTree

@Deprecated
public IPObjectTree getWorkItemTree()

Deprecated.

use TreeExportConfiguration.getWorkItemTree()

Specified by:

getWorkItemTree in interface IExportConfiguration

Returns:

A tree of Work Items to export.

See Also:

• IExportConfiguration.getWorkItems()

getWorkItems

@Deprecated
public IPObjectList getWorkItems()

Deprecated.

use TableExportConfiguration.getWorkItems()

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

Returns:

The list of IWorkItems, never null.

See Also:

• IExportConfiguration.getWorkItemTree()

getQuery

@Deprecated
public String getQuery()

Deprecated.

use TableExportConfiguration.getQuery() or TreeExportConfiguration.getQuery()

Specified by:

getQuery in interface IExportConfiguration

Returns:

The query used.