org.asam.ods

Interface ElemResultSetExtSeqIteratorOperations

All Known Subinterfaces:

ElemResultSetExtSeqIterator

All Known Implementing Classes:

_ElemResultSetExtSeqIteratorStub, ElemResultSetExtSeqIterator, ElemResultSetExtSeqIterator, ElemResultSetExtSeqIteratorPOA

public interface ElemResultSetExtSeqIteratorOperations

For iteration through the result elements, there is also a new iterator necessary called ElemResultSetExtSeqIterator. Its functionality is still the same as all other iterators and needs therefore no further explanation. There is only one difference to the other iterations. The iteration is done on the lowest level in that case on the TS_UnionSeq.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() (29000) Destroy the iterator and free the associated memory.
int	getCount() (29001) Get the total number of elements accessible by the iterator.
ElemResultSetExt[]	nextN(int how_many) (29002) Get the next n elements from the sequence.
ElemResultSetExt	nextOne() (29003) Get the attributes of the next instance element from the sequence.
void	reset() (29004) Reset the intwrnal pointer in the element sequence to the first element.

Method Detail

destroy

void destroy()
             throws AoException

(29000) 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

(29001) 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

ElemResultSetExt[] nextN(int how_many)
                         throws AoException

(29002) 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 attribute values from the element result set sequence.

Throws:

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

nextOne

ElemResultSetExt nextOne()
                         throws AoException

(29003) Get the attributes of the next instance element from the sequence. In case no element is available a NIL object is returned.

Returns:

The attribute values of the next instance element from the element result set sequence.

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

(29004) Reset the intwrnal pointer in the element sequence 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