CosTrading::OfferIdIterator Interface Reference

This interface supports operations to iterate through lists of OfferIds returned by the CosTrading::Admin interface. More...

import "CosTrading.idl";

List of all members.

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

---

Detailed Description

This interface supports operations to iterate through lists of OfferIds returned by the CosTrading::Admin interface.

---

Member Function Documentation

void CosTrading::OfferIdIterator::destroy

(

)

This operation destroys the OfferIDIterator and and any OfferIds it contains.

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

unsigned long CosTrading::OfferIdIterator::max_left

(

)

raises (UnknownMaxLeft)

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

Returns:

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

boolean CosTrading::OfferIdIterator::next_n	(	in unsigned long	n,
		out OfferIdSeq	ids
	)

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

Parameters:

	n	- The number of OfferIds to return.
	ids	- The sequence of returned OfferIds.

Returns:

- TRUE if there are more OfferIds to retrieve.