com.crystaldecisions.sdk.occa.report.data
Interface IRecordBatch

All Superinterfaces:
IClone
All Known Implementing Classes:
RecordBatch

public interface IRecordBatch
extends IClone

This interface enables you to get information about records in the record batch. The RecordBatch object stores a batch of records from the database. To navigate the records in the record batch you must use a cursor created using com.crystaldecisions.sdk.occa.report.application.RowsetController#createCursor(IGroupPath groupPath, IRowsetMetaData metaData).


Method Summary
 ICursor createCursor(CursorType cursorType, int reserved)
           Creates a cursor for this record batch.
 void ensureCapacity(int maxCapacity)
           Pre-allocates memory for the collection's array.
 int getFirstRecordKey()
           Returns the key of the first record in the record batch.
 int getRecordCount()
           Returns the number of records in the record batch.
 void removeAll()
           Removes all records from this record batch.
 void setFirstRecordKey(int firstRecordKey)
           Sets the key of the first record in the record batch.
 

Method Detail

createCursor

ICursor createCursor(CursorType cursorType,
                     int reserved)

Creates a cursor for this record batch.

Parameters:
cursorType - The type of cursor to be created.
reserved - Reserved for future use.
Returns:
A cursor for this record batch.

ensureCapacity

void ensureCapacity(int maxCapacity)

Pre-allocates memory for the collection's array. Use this method if you know exactly how many items you will be adding after calling this method; doing so will improve performance. This method does not affect the RecordCount property until items have been added. If you call this method with maxCapacity = 10, the array for the collection will be increased to accommodate 10 items, but if you have not added any items, getRecordCount will still return zero.

Parameters:
maxCapacity - The size of the array.

getFirstRecordKey

int getFirstRecordKey()

Returns the key of the first record in the record batch.

Returns:
An int that specifies the key of the first record in the record batch.

getRecordCount

int getRecordCount()

Returns the number of records in the record batch. Use the RowsetController's getRowsetBatchSize method to specify the number of records in each batch in the rowset.

Returns:
An int that specifies the number of records in the record batch.

removeAll

void removeAll()

Removes all records from this record batch.


setFirstRecordKey

void setFirstRecordKey(int firstRecordKey)

Sets the key of the first record in the record batch.

Parameters:
firstRecordKey - An int that specifies the key of the first record in the record batch.