de.tif.jacob.core.data
Interface IDataRecordSet

All Known Subinterfaces:

IDataBrowser, IDataTable

public interface IDataRecordSet

A data record set defines a container for instances of IDataRecord and also represents the joint behaviour of instances of IDataBrowser and IDataTable.

Field Summary

static int

UNLIMITED_RECORDS This constant should be used to set the maximum number of records to unlimited.

Method Summary

void	clear() Clears all records populated.
IDataAccessor	getAccessor() Returns the parent data accessor, i.e. if IDataAccessor.clear()is called, this data record set would be cleared as well.
int	getMaxRecords() Returns the current maximum number of records, i.e. when populating the number of records will be limited to this number.
java.lang.String	getName() Returns the name of this data record set.
ITableAlias	getTableAlias() Returns the underlying table alias of this record set.
boolean	hasMoreRecords() Checks whether the result set of the last search has been limited by the maximal record setting, i.e. there are more records on the respective data source.
int	recordCount() Returns the number of records, which have been populated by means of a search operation.
int	setMaxRecords(int maxRecords) Sets the maximum number of records.

Field Detail

UNLIMITED_RECORDS

static final int UNLIMITED_RECORDS

This constant should be used to set the maximum number of records to unlimited.

Note that setting the maximum record number to unlimited could overburden the system in respect of memory and CPU aspects, if the population is not limited by means of proper search constraints!

See Also:

setMaxRecords(int), Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of this data record set.

Returns:

the data record set name

clear

void clear()

Clears all records populated.

getAccessor

IDataAccessor getAccessor()

Returns the parent data accessor, i.e. if IDataAccessor.clear()is called, this data record set would be cleared as well.

Returns:

the parent data accessor

recordCount

int recordCount()

Returns the number of records, which have been populated by means of a search operation.

Returns:

the record number

hasMoreRecords

boolean hasMoreRecords()

Checks whether the result set of the last search has been limited by the maximal record setting, i.e. there are more records on the respective data source.

Returns:

Returns the hasMoreRecords.

getMaxRecords

int getMaxRecords()

Returns the current maximum number of records, i.e. when populating the number of records will be limited to this number.

Note that this value is initially set to the configured system maximum, i.e. property BROWSER_SYSTEM_MAX_RECORDS. This property could be changed by means of the jACOB administration application.

Returns:

the current maximum record setting

setMaxRecords

int setMaxRecords(int maxRecords)
                  throws java.lang.IllegalArgumentException

Sets the maximum number of records. This number restricts the result set of search operations perform on this record set.

Parameters:

maxRecords - the maximum record number

Returns:

the original setting of this value before calling this method

Throws:

java.lang.IllegalArgumentException - if maxRecords is not between 1 and UNLIMITED_RECORDS

getTableAlias

ITableAlias getTableAlias()

Returns the underlying table alias of this record set.

Returns:

the underlying table alias