oracle.jbo
Interface RowSetIterator

All Superinterfaces:

NavigatableRowIterator, RowIterator

All Known Subinterfaces:

RowSet, ViewObject

All Known Implementing Classes:

ViewRowSetIteratorImpl

public interface RowSetIterator

extends NavigatableRowIterator

Provides simple access to a set of rows.

View Object methods may use row set iterators to navigate through a row set resulting from a query. Row set iterators provide a window into the row set, making a subset of it accessible. Each row of the row set is represented by a Row object.

Since:

JDeveloper 3.0

Fields inherited from interface oracle.jbo.RowIterator

ITER_MODE_LAST_PAGE_FULL, ITER_MODE_LAST_PAGE_PARTIAL, SLOT_BEFORE_FIRST, SLOT_BEYOND_LAST, SLOT_DELETED, SLOT_VALID

Method Summary

Type	Method
void	addManagementListener(RowSetManagementListener listener) Adds a subscriber (listener) to be notified of RowSetManagementListener events generated by this row set iterator.
void	closeRowSetIterator() Closes this row set iterator.
RowSet	createDetailRowSet(java.lang.String voName, java.lang.String viewLinkDefName) Creates a detail row set.
RowSet[]	getDetailRowSets() Gets all detail row sets linked to the master row set.
java.lang.String	getName() Gets the name of the iterator.
RowSet	getRowSet() Gets the row set that this iterator belongs to.
java.lang.Object	getSyncLock() Gets the locking object for this Row Set Iterator.
boolean	isNameGenerated() Tests if the iterator's name was generated by the system.
void	removeManagementListener(RowSetManagementListener listener) Removes a subscriber (listener) for RowSetManagementListener events generated by this row set iterator.

Methods inherited from interface oracle.jbo.NavigatableRowIterator

addListener, removeListener

Methods inherited from interface oracle.jbo.RowIterator

createKey, createRow, enumerateRowsInRange, findByEntity, findByKey, first, getAllRowsInRange, getCurrentRow, getCurrentRowIndex, getCurrentRowSlot, getFetchedRowCount, getIterMode, getRangeIndexOf, getRangeSize, getRangeStart, getRow, getRowAtRangeIndex, getRowCount, getRowCountInRange, hasNext, hasPrevious, insertRow, insertRowAtRangeIndex, isRangeAtBottom, isRangeAtTop, last, next, previous, removeCurrentRow, reset, scrollRange, scrollRangeTo, setCurrentRow, setCurrentRowAtRangeIndex, setIterMode, setRangeSize, setRangeStart, setRowValidation

Method Detail

getName

public java.lang.String getName()

Gets the name of the iterator. This name can be different from row set's name.

Returns:

a name.

isNameGenerated

public boolean isNameGenerated()

Tests if the iterator's name was generated by the system.

Returns:

true if the name was generated by the system. false if the name was given by the user and not generated by the system.

getRowSet

public RowSet getRowSet()

Gets the row set that this iterator belongs to.

Returns:

a row set.

getDetailRowSets

public RowSet[] getDetailRowSets()

Gets all detail row sets linked to the master row set.

Returns:

An array of RowSet objects.

createDetailRowSet

public RowSet createDetailRowSet(java.lang.String voName,
                                 java.lang.String viewLinkDefName)

Creates a detail row set.

Parameters:

rsName - the name to be assigned to the detail Row Set.

viewLinkDefName - the name of a View Link definition.

Returns:

the detail row set.

addManagementListener

public void addManagementListener(RowSetManagementListener listener)

Adds a subscriber (listener) to be notified of RowSetManagementListener events generated by this row set iterator.

Parameters:

listener - the subscriber to be added. It should implement RowSetManagementListener.

removeManagementListener

public void removeManagementListener(RowSetManagementListener listener)

Removes a subscriber (listener) for RowSetManagementListener events generated by this row set iterator.

Parameters:

listener - the subscriber to be removed.

closeRowSetIterator

public void closeRowSetIterator()

Closes this row set iterator. If this row set iterator is a master in a master-detail relationship, closeRowSetIterator closes all detail row sets.

After that, it fires a RowSetManagementListener.iteratorClosed event to its RowSetManagementListener's.

Then, it deregisters this row set iterator from the owning row set, and deregisters all its listeners.

getSyncLock

public java.lang.Object getSyncLock()

Gets the locking object for this Row Set Iterator. Actually, this method locks the Application Module to which this Row Set Iterator belongs. See ApplicationModule.getSyncLock() for details.

Returns:

the locking object.