org.asam.ods

Interface NameIteratorOperations

All Known Subinterfaces:

NameIterator

All Known Implementing Classes:

_NameIteratorStub, NameIterator, NameIterator, NameIteratorPOA

public interface NameIteratorOperations

The ASAM ODS name iterator interface.

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() (17001) Destroy the iterator and free the associated memory.
int	getCount() (17002) Get the total number of elements accessible by the iterator.
java.lang.String[]	nextN(int how_many) (17003) Get the next n elements from the name sequence.
java.lang.String	nextOne() (17004) Get the next element from the name sequence.
void	reset() (17005) Reset the internal pointer in the element sequence to the first element.

Method Detail

destroy

void destroy()
             throws AoException

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

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

java.lang.String[] nextN(int how_many)
                         throws AoException

(17003) Get the next n elements from the name 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 names from the name 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

java.lang.String nextOne()
                         throws AoException

(17004) Get the next element from the name sequence. In case no element is available a CORBA exception will be thrown.

Returns:

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

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