ReportRequest - gopai/reporting-sdk GitHub Wiki

ReportRequest

The ReportRequest is a data structure that follows a builder pattern for creating a filtered report request.

It follows the build pattern of:

 ReportRequest.report(ReportName).setReportGUID(GUID)

      .column("ColumnName").setFilter("FilterValue").setVisible(Visible).build()

      .column("ColumnName").setFilter("FilterValue").setVisible(Visible).build(); 

etc

  • The report method - Is a static constructor that sets the report name.
  • The column method - Is the start for the Column builder.

The ReportRequest contains the Report Name, Report GUID, and a list of filter columns. There are getter and setter methods for these variables.

Column

A Column is the data structure that contains the filter column and value. These also follow a builder pattern.

The Column contains the column name, filter value, and a visibility string (so that the report can be filtered by a value that the user may not care about seeing). There are getter and setter methods for these variables.