com.cloupia.model.cIM.pagination

Class PaginationAPI

java.lang.Object

com.cloupia.model.cIM.pagination.PaginationAPI

All Implemented Interfaces:

PaginationAPIIf

public class PaginationAPI
extends java.lang.Object
implements PaginationAPIIf

Constructor Summary

Constructors

Constructor and Description
PaginationAPI()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginationAPI

public PaginationAPI()

Method Detail

userAPIgetPage

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

Specified by:

userAPIgetPage in interface PaginationAPIIf

Parameters:

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

rc - : The report context.

query - : The query.

sort - : 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

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

Specified by:

userAPIgetRowCount in interface PaginationAPIIf

Parameters:

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

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

query - : The query

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

Returns:

int : Returns number of rows per the query

Throws:

java.lang.Exception

userAPIgetTabularReportMetadata

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

Specified by:

userAPIgetTabularReportMetadata in interface PaginationAPIIf

Parameters:

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

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

Returns:

TabularReportMetadata : Returns a TabularReportMetadata object with report metadata information.

Throws:

java.lang.Exception