Package com.adobe.acs.commons.reports.api

Interface ReportExecutor

All Known Implementing Classes:
PathListReportExecutor, QueryReportExecutor
public interface ReportExecutor
Interface for report execution classes to implement. These should be Sling Models which are adaptable from a SlingHttpServletRequest and return a page of results based on the supplied configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    ResultsPage
    getAllResults()
    Return all of the results based on the request parameters and supplied configuration settings in the configuration resource.
    String
    getDetails()
    Gets the details for this report executor
    String
    getParameters()
    The parameters used to execute the report.
    default Map<String,String>
    getParamPatternMap(org.apache.sling.api.SlingHttpServletRequest request)
     
    ResultsPage
    getResults()
    Return the page of results based on the request parameters and supplied configuration settings in the configuration resource.
    void
    setConfiguration(org.apache.sling.api.resource.Resource config)
    Set the resource used to configure this report executor.
    void
    setPage(int page)
    This method will be called by the ReportRunner to set the current results page.

  • Method Details

    • getDetails

      String getDetails() throws ReportException
      Gets the details for this report executor
      Returns:
      the details
      Throws:
      ReportException

    • getParameters

      String getParameters() throws ReportException
      The parameters used to execute the report.
      Returns:
      the report parameters as a string
      Throws:
      ReportException

    • getAllResults

      ResultsPage getAllResults() throws ReportException
      Return all of the results based on the request parameters and supplied configuration settings in the configuration resource.
      Returns:
      the results
      Throws:
      ReportException

    • getResults

      ResultsPage getResults() throws ReportException
      Return the page of results based on the request parameters and supplied configuration settings in the configuration resource.
      Returns:
      the current page of results
      Throws:
      ReportException

    • setConfiguration

      void setConfiguration(org.apache.sling.api.resource.Resource config)
      Set the resource used to configure this report executor.
      Parameters:
      config - the resource to configure this report executor

    • setPage

      void setPage(int page)
      This method will be called by the ReportRunner to set the current results page.
      Parameters:
      page - the result page

    • getParamPatternMap

      default Map<String,String> getParamPatternMap(org.apache.sling.api.SlingHttpServletRequest request)