sqlj.runtime
Interface ForUpdate

public abstract interface ForUpdate

An interface implemented by iterators which will be used in a positioned update or delete statement (as parameter to a WHERE CURRENT OF clause). Any iterator which is to be passed as a parameter to a WHERE CURRENT OF clause must implement this interface.

Method Summary

Type	Method
java.lang.String	getCursorName() Get the name of the SQL cursor used by this iterator.

Method Detail

getCursorName

public java.lang.String getCursorName()
                               throws java.sql.SQLException

Get the name of the SQL cursor used by this iterator.

In SQL, a result table is retrieved through a cursor that is named. The current row of a result can be updated or deleted using a positioned update/delete statement that references the cursor name.

SQLJ supports this SQL feature by providing the name of the SQL cursor used by an iterator. The current row of an iterator is also the current row of this SQL cursor.

Note: If positioned update is not supported a SQLException is thrown

Returns:

the iterator's SQL cursor name

Throws:

java.sql.SQLException - if a database-access error occurs.