|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.application.SearchResultCursor
public class SearchResultCursor
This object is used to navigate the results of a search. Create the cursor with the
SearchController
object's
createCursor
method.
Method Summary | |
---|---|
void |
addNew()
Reserved for future use. |
void |
delete()
Reserved for future use. |
Record |
getCurrentRecord()
The record the cursor is currently pointing at. |
int |
getCurrentRecordNumber()
Returns the record number of the current cursor position. |
boolean |
getIsTotalRecordKnown()
Returns true if the total number of records is known, and false
otherwise. |
int |
getRecordCount(FetchedRecordCountInfo info)
Since this method also needs to return info indicating if all the records have been retrieved, include the FetchedRecordCountInfo structure. |
IRowset |
getRowset()
Returns the records that contain the search results fetched from the server. |
IRowsetMetaData |
getRowsetMetaData()
Returns information about the fields that the items in the record correspond to. |
boolean |
isEOF()
Returns true if the cursor is past end of rowset or before beginning, and
false otherwise. |
void |
moveFirst()
Moves the cursor to the first record in the batch. |
void |
moveLast()
Moves the cursor to the last record in the batch. |
boolean |
moveNext()
Moves to the next record in the batch. |
boolean |
movePrevious()
Moves to the previous record in the batch. |
boolean |
moveTo(int index)
Moves to a specified record in the batch. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public void addNew()
ICursor
Reserved for future use.
addNew
in interface ICursor
public void delete()
ICursor
Reserved for future use.
delete
in interface ICursor
public Record getCurrentRecord()
ICursor
The record the cursor is currently pointing at. The value returned by this method is updated whenever you move the cursor using any of the move functions.
getCurrentRecord
in interface ICursor
Record
object containing the record the cursor is currently pointing
at.public int getCurrentRecordNumber()
ICursor
Returns the record number of the current cursor position.
getCurrentRecordNumber
in interface ICursor
public boolean getIsTotalRecordKnown()
ICursor
Returns true
if the total number of records is known, and false
otherwise.
Under certain circumstances, the total record count is not known:
true
, then the value of the getRecordCount
method is the final total number of records.
getIsTotalRecordKnown
in interface ICursor
public int getRecordCount(FetchedRecordCountInfo info)
getRecordCount
in interface ICursor
info
- A FetchedRecordCountInfo
object containing key properties of the fetched
records.
public IRowset getRowset()
Returns the records that contain the search results fetched from the server.
IRowset
object containing the records that contain search results
fetched from the server.public IRowsetMetaData getRowsetMetaData()
Returns information about the fields that the items in the record correspond to. The
IRowsetMetaData
object contains the fields whose values will be returned.
These fields, which are specified in the
createCursor
method, determine the columns that are available in the search result rowset.
IRowsetMetaData
object containing information about the fields that
the items in the record correspond to.public boolean isEOF() throws ReportSDKException
Returns true
if the cursor is past end of rowset or before beginning, and
false
otherwise.
isEOF
in interface ICursor
true
if the cursor is past end of rowset or before beginning, and
false
otherwise.
ReportSDKException
public void moveFirst() throws ReportSDKException
ICursor
Moves the cursor to the first record in the batch.
moveFirst
in interface ICursor
ReportSDKException
public void moveLast() throws ReportSDKException
ICursor
Moves the cursor to the last record in the batch.
moveLast
in interface ICursor
ReportSDKException
public boolean moveNext() throws ReportSDKException
ICursor
Moves to the next record in the batch.
moveNext
in interface ICursor
ReportSDKException
public boolean movePrevious() throws ReportSDKException
ICursor
Moves to the previous record in the batch.
movePrevious
in interface ICursor
ReportSDKException
public boolean moveTo(int index) throws ReportSDKException
ICursor
Moves to a specified record in the batch. If you supply an index that is out of bounds the method will fail.
moveTo
in interface ICursor
index
- The index of the record in the batch. The batch is zero-based.
true
if there are more records after the index moved to, otherwise false
.
false
will be returned when the move is to the last indexed record.
ReportSDKException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |