Package com.xwiki.projectmanagement.macro

Class ProjectManagementChartMacroParameters

java.lang.Object
com.xwiki.projectmanagement.macro.ProjectManagementChartMacroParameters
public class ProjectManagementChartMacroParameters extends Object
Bean that represents the parameters used by the AbstractProjectManagementChartMacro implementers.
Since:
1.2.0-rc-1
Version:
$Id$

  • Constructor Details

    • ProjectManagementChartMacroParameters

      public ProjectManagementChartMacroParameters()

  • Method Details

    • getClient

      public String getClient()
      Returns:
      the client id. The client being the project management implementor. i.e. openproject.

    • setClient

      public void setClient(String client)
      Parameters:
      client - see getClient().

    • getType

      public String getType()
      Returns:
      the type of the chart. This value is associated to a chart type implementation that handles the displaying for the given filter.

    • setType

      public void setType(String type)
      Parameters:
      type - see getType().

    • getProperty

      public String getProperty()
      Returns:
      the work item property that will be used in displaying the chart.

    • setProperty

      public void setProperty(String property)
      Parameters:
      property - see getProperty().

    • getFilters

      public String getFilters()
      Returns:
      a JSON representing the filters applied on the work items dataset. The JSON is the serialized version of the LiveDataConfiguration.

    • setFilters

      public void setFilters(String filters)
      Parameters:
      filters - see getFilters().

    • getLimit

      public Integer getLimit()
      Returns:
      the limit applied of the work items resulting list.

    • setLimit

      public void setLimit(Integer limit)
      Parameters:
      limit - see getLimit().

    • getOffset

      public Long getOffset()
      Returns:
      the offset of the work items resulting list.

    • setOffset

      public void setOffset(Long offset)
      Parameters:
      offset - see getOffset().

    • getTypeParams

      public String getTypeParams()
      Returns:
      a JSON representation of the chart type implementor configuration object. A ChartTypeDisplayer will return the configuration type by calling ChartTypeDisplayer.getParameterTypeTemplate() ()}.

    • setTypeParams

      public void setTypeParams(String typeParams)
      Parameters:
      typeParams - see getTypeParams().

    • getDatasetsLabels

      public String getDatasetsLabels()
      Returns:
      a JSON array of labels used to describe each dataset displayed.

    • setDatasetsLabels

      public void setDatasetsLabels(String datasetsLabels)
      Parameters:
      datasetsLabels - see getDatasetsLabels().