This class takes care of the low-level logic for when dealing
with "e;pages"e; of data. It is used in the Download Controller
to allow paging through masses of download files, as well as in DBMaint for
paging through the data records.
Returns a search and retrieve list from the DBObject who's criteria
you have set. Also sets its internal attributes such as start record number
etc.
Parameters: searchCriteria - The DBObject to search against Parameters: sortKey - the field to search against. an ArrayList of DBObjects retrieved by the searchCriteria
Returns a search and retrieve list from the DBObject who's criteria
you have set. Also sets its internal attributes such as start record number
etc.
Parameters: searchCriteria - The DBObject to search against Parameters: sortKey - the field to search against. an ArrayList of DBObjects retrieved by the searchCriteria
setCountRecords
public void setCountRecords(boolean newCountRecords)(Code)
Sets whether or not the total record count should be used or not.
Parameters: newCountRecords - true if you wish for the recordset to retrievea total record count.
setEndRecordNumber
public void setEndRecordNumber(int newEndRecordNumber)(Code)
Sets the ending record number
Parameters: newEndRecordNumber - int for the new end record number
setMoreRecords
public void setMoreRecords(boolean newMoreRecords)(Code)
Sets the size of the page limit. It uses the DBObject Limit to define
how many records per page are displayed
Parameters: dbObj - The dbobject to set for.
Sets the size of the page limit. It uses the DBObject Limit to define
how many records per page are displayed
Parameters: dbObj - The dbobject to set for.
setPageNumber
public void setPageNumber(int newPageNumber)(Code)
Sets the page number based upon the controller request object.
If the page parameters is not included with the request, then page
is set to zero.
Parameters: request - The controller request fed to the controller from which thefunction can extract the page= controller parameter. throws: ControllerException - if page= is not a number.
setPreviousRecords
public void setPreviousRecords(boolean newPreviousRecords)(Code)
setStartRecordNumber
public void setStartRecordNumber(int newStartRecordNumber)(Code)