Package com.polarion.alm.tracker.workreport

Class WorkReportConfiguration

java.lang.Object

com.polarion.alm.tracker.workreport.WorkReportConfiguration

All Implemented Interfaces:

IWorkReportConfiguration

public class WorkReportConfiguration
extends Object
implements IWorkReportConfiguration

Author:

Jiri Banszel, POLARION SOFTWARE

Constructor Summary

Constructors

Constructor	Description
WorkReportConfiguration(String title, Properties props)

Method Summary

Modifier and Type	Method	Description
IContextId	getContextId()	Only work records from work items in this context will be included in the report.
List	getGroupings()	Grouping definition - a list of grouping ids.
boolean	getIncludeTimeline()	Whether to include the timeline in the report (showing time spent on individual days, weeks, etc., see IWorkReportConfiguration.getTimeScale()).
boolean	getIncludeWorkRecordList()	Whether to include the list of corresponding Work Records below each leaf group in the report.
Date	getPeriodEnd()	Only work records with this date or earlier will be included in the report.
Date	getPeriodStart()	Only work records with this date or later will be included in the report.
Properties	getProperties()	Named values that will be presented in the work report.
String	getTimeScale()	Scale of the timeline.
String	getTitle()	Returns title of the report that will be presented in the report.
IPObjectList	getWorkItems()	If set only work records from the work items in the list will be included in the report.
String	getWorkItemsQuery()	If set only work records from the work items matching the query will be included in the report.
void	setContextId(IContextId contextId)
void	setGroupings(List groupings)
void	setIncludeTimeline(boolean includeTimeline)
void	setIncludeWorkRecordList(boolean includeWorkRecordList)
void	setPeriodEnd(Date periodEnd)
void	setPeriodStart(Date periodStart)
void	setTimeScale(String timeScale)
void	setWorkItems(IPObjectList workItems)
void	setWorkItemsQuery(String query)

Methods inherited from class java.lang.Object

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

Constructor Details

WorkReportConfiguration

public WorkReportConfiguration(String title,
 Properties props)

Method Details

getTitle

public String getTitle()

Description copied from interface: IWorkReportConfiguration

Returns title of the report that will be presented in the report.

Specified by:

getTitle in interface IWorkReportConfiguration

getProperties

public Properties getProperties()

Description copied from interface: IWorkReportConfiguration

Named values that will be presented in the work report.

Specified by:

getProperties in interface IWorkReportConfiguration

getContextId

public IContextId getContextId()

Description copied from interface: IWorkReportConfiguration

Only work records from work items in this context will be included in the report.

Specified by:

getContextId in interface IWorkReportConfiguration

Returns:

the IContextId for this configuration

setContextId

public void setContextId(IContextId contextId)

getGroupings

public List getGroupings()

Description copied from interface: IWorkReportConfiguration

Grouping definition - a list of grouping ids.

Specified by:

getGroupings in interface IWorkReportConfiguration

Returns:

list of Strings

See Also:

• IWorkReportManager.getGroupingOptions()

setGroupings

public void setGroupings(List groupings)

getPeriodStart

public Date getPeriodStart()

Description copied from interface: IWorkReportConfiguration

Only work records with this date or later will be included in the report.

Specified by:

getPeriodStart in interface IWorkReportConfiguration

Returns:

date or null if there is no such limit on work records

setPeriodStart

public void setPeriodStart(Date periodStart)

getPeriodEnd

public Date getPeriodEnd()

Description copied from interface: IWorkReportConfiguration

Only work records with this date or earlier will be included in the report.

Specified by:

getPeriodEnd in interface IWorkReportConfiguration

Returns:

date or null if there is no such limit on work records

setPeriodEnd

public void setPeriodEnd(Date periodEnd)

getTimeScale

public String getTimeScale()

Description copied from interface: IWorkReportConfiguration

Scale of the timeline. Has no effect if IWorkReportConfiguration.getIncludeTimeline() returns false.

Specified by:

getTimeScale in interface IWorkReportConfiguration

Returns:

time scale option id

See Also:

• IWorkReportManager.getTimeScaleOptions()

getIncludeTimeline

public boolean getIncludeTimeline()

Description copied from interface: IWorkReportConfiguration

Whether to include the timeline in the report (showing time spent on individual days, weeks, etc., see IWorkReportConfiguration.getTimeScale()).

Specified by:

getIncludeTimeline in interface IWorkReportConfiguration

setIncludeTimeline

public void setIncludeTimeline(boolean includeTimeline)

Since:

3.3

setTimeScale

public void setTimeScale(String timeScale)

setIncludeWorkRecordList

public void setIncludeWorkRecordList(boolean includeWorkRecordList)

Since:

3.3

getIncludeWorkRecordList

public boolean getIncludeWorkRecordList()

Description copied from interface: IWorkReportConfiguration

Whether to include the list of corresponding Work Records below each leaf group in the report.

Specified by:

getIncludeWorkRecordList in interface IWorkReportConfiguration

getWorkItems

public IPObjectList getWorkItems()

Description copied from interface: IWorkReportConfiguration

If set only work records from the work items in the list will be included in the report.

Specified by:

getWorkItems in interface IWorkReportConfiguration

Returns:

list of IWorkItem or null

setWorkItems

public void setWorkItems(IPObjectList workItems)

setWorkItemsQuery

public void setWorkItemsQuery(String query)

Since:

3.5.0

getWorkItemsQuery

public String getWorkItemsQuery()

Description copied from interface: IWorkReportConfiguration

If set only work records from the work items matching the query will be included in the report. If IWorkReportConfiguration.getWorkItems() returns non-null list, this query is ignored.

Specified by:

getWorkItemsQuery in interface IWorkReportConfiguration