Package com.polarion.alm.tracker.workreport

Interface IWorkReportConfiguration

All Known Implementing Classes:
WorkReportConfiguration
public interface IWorkReportConfiguration
Sole implementation of this interface is WorkReportConfiguration.
Author:
Jiri Banszel, POLARION SOFTWARE

  • 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 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.

  • Method Details

    • getTitle

      String getTitle()
      Returns title of the report that will be presented in the report.

    • getIncludeTimeline

      boolean getIncludeTimeline()
      Whether to include the timeline in the report (showing time spent on individual days, weeks, etc., see getTimeScale()).
      Since:
      3.3

    • getTimeScale

      String getTimeScale()
      Scale of the timeline. Has no effect if getIncludeTimeline() returns false.
      Returns:
      time scale option id
      See Also:

    • getIncludeWorkRecordList

      boolean getIncludeWorkRecordList()
      Whether to include the list of corresponding Work Records below each leaf group in the report.
      Since:
      3.3

    • getGroupings

      List getGroupings()
      Grouping definition - a list of grouping ids.
      Returns:
      list of Strings
      See Also:

    • getProperties

      Properties getProperties()
      Named values that will be presented in the work report.

    • getContextId

      IContextId getContextId()
      Only work records from work items in this context will be included in the report.
      Returns:
      the IContextId for this configuration

    • getPeriodStart

      Date getPeriodStart()
      Only work records with this date or later will be included in the report.
      Returns:
      date or null if there is no such limit on work records

    • getPeriodEnd

      Date getPeriodEnd()
      Only work records with this date or earlier will be included in the report.
      Returns:
      date or null if there is no such limit on work records

    • getWorkItems

      IPObjectList getWorkItems()
      If set only work records from the work items in the list will be included in the report.
      Returns:
      list of IWorkItem or null

    • getWorkItemsQuery

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