org.asam.ods

Interface NameValueIteratorOperations

All Known Subinterfaces:

NameValueIterator

All Known Implementing Classes:

_NameValueIteratorStub, NameValueIterator, NameValueIterator, NameValueIteratorPOA

public interface NameValueIteratorOperations

The ASAM ODS name-value iterator interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() (18001) Destroy the iterator and free the associated memory.
int	getCount() (18002) Get the total number of elements accessible by the iterator.
NameValue[]	nextN(int how_many) (18003) Get the next n elements from the NameValue sequence.
NameValue	nextOne() (18004) Get the next element from the NameValue sequence.
void	reset() (18005) Reset the internal pointer in the element sequence to the first element.

Method Detail

destroy

void destroy()
             throws AoException

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

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

NameValue[] nextN(int how_many)
                  throws AoException

(18003) Get the next n elements from the NameValue 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 NameValue pairs from the NameValue pair 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

NameValue nextOne()
                  throws AoException

(18004) Get the next element from the NameValue sequence. In case no element is available a NIL object is returned.

Returns:

The next NameValue pair from the NameValue pair 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

(18005) Reset the internal 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