|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DatabaseRequest
Interface for database request
Method Summary | |
---|---|
java.lang.String |
buildURI()
Build the URI to the current Record |
int |
calculateTotalCountFromBase()
Compute from the database the number of Records in the current request |
void |
checkRequest()
Check that the given request is correct and can be executed |
void |
close()
Close the connection |
void |
createDistinctRequest()
Create a SQL Distinct request |
void |
createRequest()
Create a Request |
int |
getCount()
Get the number of results in the current request for pagination purpose |
java.lang.String |
getDistinctRequestAsString()
Gets the distinct request as a String |
int |
getMaxResultsToSend()
Get the maximal number of results in the current request |
java.util.List<java.lang.String> |
getPrimaryKeys()
Get the list of primary keys in the DataSet |
Record |
getRecord()
Return the current ResultSet in a Record object |
java.lang.String |
getRequestAsString()
Gets the request as a String |
java.util.List<java.lang.String> |
getSelectedPrimaryKey()
Get the selected primary keys |
int |
getStartIndex()
Get the index of the first result in the current request |
int |
getTotalCount()
get the number of records in the current request |
boolean |
isCountDone()
If the count must be done or not |
boolean |
isLastResult()
Deprecated. |
boolean |
nextResult()
Move the cursor on the next result. |
Method Detail |
---|
java.util.List<java.lang.String> getPrimaryKeys()
java.util.List<java.lang.String> getSelectedPrimaryKey()
void createDistinctRequest() throws SitoolsException
SitoolsException
- when occursvoid createRequest() throws SitoolsException
SitoolsException
- when request failsint getTotalCount()
int getCount()
int getStartIndex()
boolean nextResult() throws SitoolsException
true
if the new current row is valid; false
if there are no more rows
SitoolsException
- if a database access error occurs or this method is called on a closed result setboolean isLastResult() throws SitoolsException
ResultSet
object or is the last
ResultSet
to send.
true
if the cursor is on the last row or is the last row to send.; false
otherwise
SitoolsException
- if a database access error occurs or this method is called on a closed result setRecord getRecord() throws SitoolsException
ResultSet
in a Record
object
Record
of the current ResultSet
SitoolsException
- if a database access error occurs or this method is called on a closed result setvoid close() throws SitoolsException
SitoolsException
- if a database access error occurs or this method is called on a closed result setboolean isCountDone()
java.lang.String getDistinctRequestAsString() throws SitoolsException
SitoolsException
- when occursjava.lang.String getRequestAsString() throws SitoolsException
SitoolsException
- when occursint getMaxResultsToSend()
java.lang.String buildURI() throws SitoolsException
SitoolsException
- if a database access error occurs or this method is called on a closed result setint calculateTotalCountFromBase() throws SitoolsException
SitoolsException
- if a database access error occurs or this method is called on a closed result setvoid checkRequest() throws SitoolsException
SitoolsException
- if the given request is not correct
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |