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
ConstructorsConstructorDescriptionQueryReportExecutor(org.apache.sling.api.SlingHttpServletRequest request, com.day.cq.search.QueryBuilder queryBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturn all of the results based on the request parameters and supplied configuration settings in the configuration resource.Gets the details for this report executorThe parameters used to execute the report.Return the page of results based on the request parameters and supplied configuration settings in the configuration resource.voidsetConfiguration(org.apache.sling.api.resource.Resource config) Set the resource used to configure this report executor.voidsetPage(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, waitMethods inherited from interface com.adobe.acs.commons.reports.api.ReportExecutor
getParamPatternMap
-
Constructor Details
-
QueryReportExecutor
@Inject public QueryReportExecutor(org.apache.sling.api.SlingHttpServletRequest request, com.day.cq.search.QueryBuilder queryBuilder)
-
-
Method Details
-
getAllResults
Description copied from interface:ReportExecutorReturn all of the results based on the request parameters and supplied configuration settings in the configuration resource.- Specified by:
getAllResultsin interfaceReportExecutor- Returns:
- the results
- Throws:
ReportException
-
getDetails
Description copied from interface:ReportExecutorGets the details for this report executor- Specified by:
getDetailsin interfaceReportExecutor- Returns:
- the details
- Throws:
ReportException
-
getParameters
Description copied from interface:ReportExecutorThe parameters used to execute the report.- Specified by:
getParametersin interfaceReportExecutor- Returns:
- the report parameters as a string
- Throws:
ReportException
-
getResults
Description copied from interface:ReportExecutorReturn the page of results based on the request parameters and supplied configuration settings in the configuration resource.- Specified by:
getResultsin interfaceReportExecutor- Returns:
- the current page of results
- Throws:
ReportException
-
setConfiguration
public void setConfiguration(org.apache.sling.api.resource.Resource config) Description copied from interface:ReportExecutorSet the resource used to configure this report executor.- Specified by:
setConfigurationin interfaceReportExecutor- Parameters:
config- the resource to configure this report executor
-
setPage
public void setPage(int page) Description copied from interface:ReportExecutorThis method will be called by the ReportRunner to set the current results page.- Specified by:
setPagein interfaceReportExecutor- Parameters:
page- the result page
-