org.asam.ods

Interface NameValueUnitSequenceIteratorOperations

All Known Subinterfaces:

NameValueUnitSequenceIterator

All Known Implementing Classes:

_NameValueUnitSequenceIteratorStub, NameValueUnitSequenceIterator, NameValueUnitSequenceIterator, NameValueUnitSequenceIteratorPOA

public interface NameValueUnitSequenceIteratorOperations

The name value unit sequence iterator. The table iterator as query result.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() (27001) Destroy the iterator and free the associated memory.
int	getCount() (27002) Get the total number of elements accessible by the iterator.
NameValueSeqUnit[]	nextN(int how_many) (27003) Get the next n elements from the sequence.
NameValueSeqUnit	nextOne() (27004) Get the next element from the iterator.
void	reset() (27005) Reset the internal pointer in the element iterator to the first element.

Method Detail

destroy

void destroy()
             throws AoException

(27001) Destroy the iterator and free the associated memory.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

getCount

int getCount()
             throws AoException

(27002) Get the total number of elements accessible by the iterator.

Returns:

The number of elements accessible by the iterator.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

nextN

NameValueSeqUnit[] nextN(int how_many)
                         throws AoException

(27003) Get the next n elements from the sequence. In case there are less elements available than requested, only as many as are available will be returned; if there is none left an empty list is returned.

Parameters:

how_many - The number of requested elements.

Returns:

The next n values of the name-value-unit sequence. For each NameValuUnit the next n values are stored in the value sequence.

Throws:

AoException - with the following possible error codes: AO_BAD_PARAMETER AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

nextOne

NameValueSeqUnit nextOne()
                         throws AoException

(27004) Get the next element from the iterator. In case no element is available a NIL object is returned.

Returns:

The next name-value-unit tuple sequence from the name-value-unit tuple.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE

reset

void reset()
           throws AoException

(27005) Reset the internal pointer in the element iterator to the first element.

Throws:

AoException - with the following possible error codes: AO_CONNECTION_LOST AO_IMPLEMENTATION_PROBLEM AO_NOT_IMPLEMENTED AO_NO_MEMORY AO_SESSION_NOT_ACTIVE