Package com.polarion.alm.tracker.workreport

Interface IWorkReportManager

public interface IWorkReportManager

Author:

Jiri Banszel, POLARION SOFTWARE

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IWorkReportManager.IOption

Method Summary

Modifier and Type	Method	Description
Collection	getGroupingOptions()
Collection	getTimeScaleOptions()
IReport	getWorkReport(IContextId contextId, String fileName)	Returns the work report or null if it does not exist.
Collection	getWorkReports(IContextId contextId)	Returns work reports existing in the context.
void	removeWorkReport(IContextId contextId, String fileName)	Removes the work report if it exists.
IJob	startWorkReport(String fileName, boolean overwrite, IWorkReportConfiguration configuration)	Starts the work report job.

Method Details

getTimeScaleOptions

Collection getTimeScaleOptions()

Returns:

list of IWorkReportManager.IOptions.

getGroupingOptions

Collection getGroupingOptions()

Returns:

list of IWorkReportManager.IOptions.

getWorkReports

Collection getWorkReports(IContextId contextId)
                   throws IOException

Returns work reports existing in the context.

Parameters:

contextId -

Returns:

collection of IReports

Throws:

IOException

getWorkReport

IReport getWorkReport(IContextId contextId,
 String fileName)
               throws IOException

Returns the work report or null if it does not exist.

Parameters:

contextId -

fileName -

Throws:

IOException

removeWorkReport

void removeWorkReport(IContextId contextId,
 String fileName)
               throws IOException

Removes the work report if it exists.

Parameters:

contextId -

fileName -

Throws:

IOException

startWorkReport

IJob startWorkReport(String fileName,
 boolean overwrite,
 IWorkReportConfiguration configuration)

Starts the work report job.

Parameters:

fileName -

overwrite -

configuration -

Returns:

work report job

See Also:

• getWorkReport(IContextId, String)