org.asam.ods

Class _InstanceElementIteratorStub

java.lang.Object

org.omg.CORBA.portable.ObjectImpl

org.asam.ods._InstanceElementIteratorStub

All Implemented Interfaces:

java.io.Serializable, InstanceElementIterator, InstanceElementIteratorOperations, org.omg.CORBA.Object, org.omg.CORBA.portable.IDLEntity

public class _InstanceElementIteratorStub
extends org.omg.CORBA.portable.ObjectImpl
implements InstanceElementIterator

The ASAM ODS instance element iterator interface.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
_InstanceElementIteratorStub()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	_ids()
void	destroy() (15001) Destroy the iterator and free the associated memory.
int	getCount() (15002) Get the total number of elements accessible by the iterator.
InstanceElement[]	nextN(int how_many) (15003) Get the next n elements from the sequence.
InstanceElement	nextOne() (15004) Get the next element from the sequence.
void	reset() (15005) Reset the pointer in the element sequence to the first element.

Methods inherited from class org.omg.CORBA.portable.ObjectImpl

_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.omg.CORBA.Object

_create_request, _create_request, _duplicate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _is_a, _is_equivalent, _non_existent, _release, _request, _set_policy_override

Constructor Detail

_InstanceElementIteratorStub

public _InstanceElementIteratorStub()

Method Detail

destroy

public void destroy()
             throws AoException

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

Specified by:

destroy in interface InstanceElementIteratorOperations

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

public int getCount()
             throws AoException

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

Specified by:

getCount in interface InstanceElementIteratorOperations

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

public InstanceElement[] nextN(int how_many)
                        throws AoException

(15003) 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.

Specified by:

nextN in interface InstanceElementIteratorOperations

Parameters:

how_many - The number of requested elements.

Returns:

The next n instance elements from the instance 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

public InstanceElement nextOne()
                        throws AoException

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

Specified by:

nextOne in interface InstanceElementIteratorOperations

Returns:

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

public void reset()
           throws AoException

(15005) Reset the pointer in the element sequence to the first element.

Specified by:

reset in interface InstanceElementIteratorOperations

Throws:

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

_ids

public java.lang.String[] _ids()

Specified by:

_ids in class org.omg.CORBA.portable.ObjectImpl