All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVaultClientCPP Class ENOVIVaultReadIterator
ENOVIVaultReadIterator
Usage: you must use this class as is. You should never derive it.
public class ENOVIVaultReadIterator
This class supplies methods to read collections of document.
role: In combination with the cache mechanism, it provides significants performance
improvements when reading collection of documents
Constructor and Destructor Index
- o
ENOVIVaultReadIterator()
- Constructs an Iterator
- o
ENOVIVaultReadIterator(ENOVIVaultDocumentColl&)
- Constructs an iterator to be used with the document collection given as input.
- o
~ENOVIVaultReadIterator()
-
Method Index
- o
endRead()
- Terminates the read operation.
- o
hasNext()
- Tells if there are remaining documents to read.
- o
next(ENOVIVaultDocument**,ENOVIVaultError&)
- Fetches the next document to read.
- o
startRead(ENOVIVaultError&)
- Starts the read operation.
Constructor and Destructor
o ENOVIVaultReadIterator
public ENOVIVaultReadIterator( | ) |
-
Constructs an Iterator
o ENOVIVaultReadIterator
-
Constructs an iterator to be used with the document collection given as input.
- Parameters:
-
- iDocColl
- [in] - Document collection to read
o ~ENOVIVaultReadIterator
public ~ENOVIVaultReadIterator( | ) |
-
Methods
o endRead
-
Terminates the read operation.
o hasNext
-
Tells if there are remaining documents to read.
- Returns:
- CATTrue, CATFalse
o next
-
Fetches the next document to read.
The document can then be read using the appropriate methods
on the
ENOVIVaultDocument class
- Parameters:
-
- oNextDoc
- [out] - Next Document to read
o startRead
-
Starts the read operation.
This method must only be called once for a given iterator
- Parameters:
-
- oVaultError
- [out] - Details about the error.
This object is included in the file: ENOVIVaultReadIterator.h
If needed, your Imakefile.mk should include the module: ENOVIVaultClientAPP