CosTrading::OfferIterator Interface Reference

This interface supports operations to iterate through lists of Offers returned by the CosTrading::Lookup::query operation. More...

import "CosTrading.idl";

List of all members.

Public Member Functions
unsigned long	max_left () raises (UnknownMaxLeft)
	This operation returns the number of remaining Offers contained within the iterator.
boolean	next_n (in unsigned long n, out OfferSeq offers)
	This operation returns up to a specified number of remaining Offers.
void	destroy ()
	This operation destroys the OfferIterator and and any Offers it contains.

---

Detailed Description

This interface supports operations to iterate through lists of Offers returned by the CosTrading::Lookup::query operation.

---

Member Function Documentation

void CosTrading::OfferIterator::destroy

(

)

This operation destroys the OfferIterator and and any Offers it contains.

This should be called after a client has finished with the iterator.

unsigned long CosTrading::OfferIterator::max_left

(

)

raises (UnknownMaxLeft)

This operation returns the number of remaining Offers contained within the iterator.

Returns:

- The number of remaining offers. UnknownMaxLeft - If the number of remaining offers cannot be determined.

boolean CosTrading::OfferIterator::next_n	(	in unsigned long	n,
		out OfferSeq	offers
	)

This operation returns up to a specified number of remaining Offers.

Parameters:

	n	- The number of Offers to return.
	offers	- The sequence of returned Offers.

Returns:

- TRUE if there are more Offers to retrieve.