com.adobe.acs.commons.reports.models

Class QueryReportExecutor

java.lang.Object

com.adobe.acs.commons.reports.models.QueryReportExecutor

All Implemented Interfaces:

ReportExecutor

@Model(adaptables=org.apache.sling.api.SlingHttpServletRequest.class)
public class QueryReportExecutor
extends Object
implements ReportExecutor

Model for executing report requests.

Constructor Summary

Constructors

Constructor and Description
QueryReportExecutor(org.apache.sling.api.SlingHttpServletRequest request)

Method Summary

Modifier and Type	Method and 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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adobe.acs.commons.reports.api.ReportExecutor

getParamPatternMap

Constructor Detail

QueryReportExecutor

public QueryReportExecutor(org.apache.sling.api.SlingHttpServletRequest request)

Method Detail

getAllResults

public ResultsPage getAllResults()
                          throws ReportException

Description copied from interface: ReportExecutor

Return all of the results based on the request parameters and supplied configuration settings in the configuration resource.

Specified by:

getAllResults in interface ReportExecutor

Returns:

the results

Throws:

ReportException

getDetails

public String getDetails()
                  throws ReportException

Description copied from interface: ReportExecutor

Gets the details for this report executor

Specified by:

getDetails in interface ReportExecutor

Returns:

the details

Throws:

ReportException

getParameters

public String getParameters()
                     throws ReportException

Description copied from interface: ReportExecutor

The parameters used to execute the report.

Specified by:

getParameters in interface ReportExecutor

Returns:

the report parameters as a string

Throws:

ReportException

getResults

public ResultsPage getResults()
                       throws ReportException

Description copied from interface: ReportExecutor

Return the page of results based on the request parameters and supplied configuration settings in the configuration resource.

Specified by:

getResults in interface ReportExecutor

Returns:

the current page of results

Throws:

ReportException

setConfiguration

public void setConfiguration(org.apache.sling.api.resource.Resource config)

Description copied from interface: ReportExecutor

Set the resource used to configure this report executor.

Specified by:

setConfiguration in interface ReportExecutor

Parameters:

config - the resource to configure this report executor

setPage

public void setPage(int page)

Description copied from interface: ReportExecutor

This method will be called by the ReportRunner to set the current results page.

Specified by:

setPage in interface ReportExecutor

Parameters:

page - the result page