com.cloupia.model.cIM.pagination

Interface PaginationAPIIf

All Known Implementing Classes:

PaginationAPI

public interface PaginationAPIIf

Supports pagination for UCS Director data query results.

Method Summary

Modifier and Type	Method and Description
TabularReport	userAPIgetPage(java.lang.String reportName, ReportContext reportContext, Query query, SortCriteria[] sortCriteria, int startIndex, int endIndex)
int	userAPIgetRowCount(java.lang.String reportName, ReportContext reportContext, Query query, SortCriteria sortCriteria)
TabularReportMetadata	userAPIgetTabularReportMetadata(java.lang.String reportName, ReportContext reportContext)

Method Detail

userAPIgetPage

TabularReport userAPIgetPage(java.lang.String reportName,
                             ReportContext reportContext,
                             Query query,
                             SortCriteria[] sortCriteria,
                             int startIndex,
                             int endIndex)
                      throws java.lang.Exception

Parameters:

reportName - : Name of the report. This is a mandatory parameter.

reportContext - : The report context.

query - : The query.

sortCriteria - : The sort criteria.

startIndex - : The start index.

endIndex - : The end index.

Returns:

TabularReport : Returns query results using specific start and stop position criteria.

Throws:

java.lang.Exception

userAPIgetRowCount

int userAPIgetRowCount(java.lang.String reportName,
                       ReportContext reportContext,
                       Query query,
                       SortCriteria sortCriteria)
                throws java.lang.Exception

Parameters:

reportName - : Name of the report. This is a mandatory parameter.

reportContext - : Report context. For possible values, see example.

query - : The query

sortCriteria - : The sort criteria. For possible values, see example.

Returns:

int : Returns number of rows per the query

Throws:

java.lang.Exception

userAPIgetTabularReportMetadata

TabularReportMetadata userAPIgetTabularReportMetadata(java.lang.String reportName,
                                                      ReportContext reportContext)
                                               throws java.lang.Exception

Parameters:

reportName - : Name of the report. This is a mandatory parameter.

reportContext - : Report context. For possible values, see example.

Returns:

TabularReportMetadata : Returns a TabularReportMetadata object with report metadata information.

Throws:

java.lang.Exception