org.omg.CosTrading
Interface OfferIdIteratorOperations

All Known Subinterfaces:

OfferIdIterator

All Known Implementing Classes:

_OfferIdIteratorStub, OfferIdIterator, OfferIdIteratorPOA, OfferIdIteratorPOATie

public interface OfferIdIteratorOperations

The OfferIdIterator interface is used to return a set of offer identifiers from the list_offers operation and the list_proxies operation in the Admin interface by enabling the offer identifiers to be extracted by successive operations on the OfferIdIterator interface.

Method Summary

void	destroy() The destroy operation destroys the iterator.
int	max_left() The max_left operation returns the number of offer identifiers remaining in the iterator.
boolean	next_n(int n, OfferIdSeqHolder ids) The next_n operation returns a set of offer identifiers in the output parameter ids.

Method Detail

max_left

int max_left()
             throws UnknownMaxLeft

The max_left operation returns the number of offer identifiers remaining in the iterator. The exception UnknownMaxLeft is raised if the iterator cannot determine the remaining number of offer identifiers (e.g., if the iterator determines its set of offer identifiers through lazy evaluation).

Throws:

UnknownMaxLeft

next_n

boolean next_n(int n,
               OfferIdSeqHolder ids)

The next_n operation returns a set of offer identifiers in the output parameter ids. The operation returns n offer identifiers if there are at least n offer identifiers remaining in the iterator. If there are fewer than n offer identifiers in the iterator, then all remaining offer identifiers are returned. The actual number of offer identifiers returned can be determined from the length of the ids sequence. The next_n operation returns TRUE if there are further offer identifiers to be extracted from the iterator. It returns FALSE if there are no further offer identifiers to be extracted.

destroy

void destroy()

The destroy operation destroys the iterator. No further operations can be invoked on an iterator after it has been destroyed.