xmlstore::Cursor Interface Reference

import "archive_xmlstore_if.idl";

Inheritance diagram for xmlstore::Cursor:

[legend]Collaboration diagram for xmlstore::Cursor:

[legend]List of all members.

Public Types
typedef sequence< QueryResult >	QueryResultSeq
Public Member Functions
boolean	hasNext () raises (ArchiveInternalError)
QueryResult	next () raises (ArchiveInternalError)
QueryResultSeq	nextBlock (in short size) raises (ArchiveInternalError)
oneway void	close ()

---

Detailed Description

This interface provides a cursor functionality for query results. A Cursor holds all query results that can be retrieved from the cursor one by one or in blocks. A cursor lives in the database and must be closed when it is no longer used.

---

Member Typedef Documentation

typedef sequence<QueryResult> xmlstore::Cursor::QueryResultSeq

A sequence of QueryResults.

---

Member Function Documentation

oneway void xmlstore::Cursor::close (   )

Closes the cursor to free resources. It is obligatory to call this method when the cursor object is no longer needed.

boolean xmlstore::Cursor::hasNext (   )  raises (ArchiveInternalError)

Returns true if there are more results in the cursor.

QueryResult xmlstore::Cursor::next (   )  raises (ArchiveInternalError)

Fetches the next result from the cursor.

QueryResultSeq xmlstore::Cursor::nextBlock (  in short  size  )  raises (ArchiveInternalError)

Fetches the next block of query results from the cursor.

---

The documentation for this interface was generated from the following file:

• archive_xmlstore_if.idl

---