com.cloupia.model.cIM.pagination

Interface PaginationProviderIf

All Known Implementing Classes:

EasyReportPaginatedReportHandler, PaginatedChangeRecordReportHandler, PaginatedChargebackPerGroupReportHandler, PaginatedChargebackPerVDCReportHandler, PaginatedChargebackReportHandler, PaginatedCloudnameEventReportHandler, PaginatedCloudnameReportHandler, PaginatedGroupReportHandler, PaginatedIdReportHandler, PaginatedLoginIdReportHandler, PaginatedReportHandler, PaginatedSRIdReportHandler, PaginatedVdcIdReportHandler, VMaxDataDevicePaginatedReportHandler, VMaxMetaDevicePaginatedReportHandler, VMaxRegularDevicePaginatedReportHandler, VMaxThinDevicePaginatedReportHandler, VMPaginatedReportHandler

public interface PaginationProviderIf

Method Summary

Modifier and Type	Method and Description
Query	appendContextSubQuery(ReportRegistryEntry entry, TabularReportMetadata md, ReportContext rc, Query query) If the report context necessitates the query be appended with additional clauses.
TabularReport	getPage(java.lang.String reportName, ReportContext rc, Query query, SortCriteria[] sort, int startIndex, int endIndex, boolean isExport) Returns the set of rows matching the given query between start and end.
int	getRowCount(java.lang.String reportName, ReportContext rc, Query query, SortCriteria sort) Returns the total number of rows matching the given query.
TabularReportMetadata	getTabularReportMetadata(java.lang.String reportName, ReportContext rc) Returns the column definitions and any ui customizations for the given report.

Method Detail

getPage

TabularReport getPage(java.lang.String reportName,
                      ReportContext rc,
                      Query query,
                      SortCriteria[] sort,
                      int startIndex,
                      int endIndex,
                      boolean isExport)
               throws java.lang.Exception

Returns the set of rows matching the given query between start and end. The rows should be wrapped inside a TabularReport and sorted in the given criteria.

Parameters:

reportName - Name of the report to gather rows for.

rc - The report context to retrieve rows with.

query - Any additional clauses to tack on to the base query.

sort - The sort order for columns.

startIndex - The starting index to get rows for.

endIndex - The ending index to get rows for.

Returns:

Throws:

java.lang.Exception

getRowCount

int getRowCount(java.lang.String reportName,
                ReportContext rc,
                Query query,
                SortCriteria sort)
         throws java.lang.Exception

Returns the total number of rows matching the given query.

Parameters:

reportName - Name of report to get row count for.

rc - The report context to retrieve rows with.

query - Any additional clauses to tack on to base query.

sort - Sort order, but is irrelevant in this case.

Returns:

Throws:

java.lang.Exception

getTabularReportMetadata

TabularReportMetadata getTabularReportMetadata(java.lang.String reportName,
                                               ReportContext rc)

Returns the column definitions and any ui customizations for the given report.

Parameters:

reportName - Name of report to get metadata for.

rc - The report context to get metadata for.

Returns:

appendContextSubQuery

Query appendContextSubQuery(ReportRegistryEntry entry,
                            TabularReportMetadata md,
                            ReportContext rc,
                            Query query)

If the report context necessitates the query be appended with additional clauses. This is where the additional query parameters need to be included. A query on top of the base query passed in along with any additional modifications should be returned if applicable. Otherwise it should just return the original query if there is no need.

Parameters:

entry - The report registry entry for this report.

md - All the metadata for this report.

rc - The report context to determine if this query needs appending.

query - The base query as passed in from UI.

Returns: