org.omg.CosPropertyService
Interface PropertiesIteratorOperations

All Known Subinterfaces:

PropertiesIterator

All Known Implementing Classes:

_PropertiesIteratorStub, PropertiesIteratorImpl, PropertiesIteratorPOA, PropertiesIteratorPOATie

public interface PropertiesIteratorOperations

A PropertySet maintains a set of name-value pairs. The get_all_properties operation of the PropertySet interface returns a sequence of Property structures (Properties). If there are additional properties, the get_all_properties operation returns an object supporting the PropertiesIterator interface with the additional properties.

The PropertiesIterator interface allows a client to iterate through the name-value pairs using the next_one or next_n operations.

Method Summary

void	destroy() The destroy operation destroys the iterator.
boolean	next_n(int how_many, PropertiesHolder nproperties) The next_n operation returns true if an item exists at the current position in the iterator and the how_many parameter was set greater than zero.
boolean	next_one(PropertyHolder aproperty) The next_one operation returns true if an item exists at the current position in the iterator with an output parameter of a property name.
void	reset() The reset operation resets the position in an iterator to the first property name, if one exists.

Method Detail

reset

void reset()

The reset operation resets the position in an iterator to the first property name, if one exists.

next_one

boolean next_one(PropertyHolder aproperty)

The next_one operation returns true if an item exists at the current position in the iterator with an output parameter of a property name. A return of false signifies no more items in the iterator.

Parameters:

aproperty - the retrieved property is returned in the output parameter.

Returns:

true if a property name was retrieved.

next_n

boolean next_n(int how_many,
               PropertiesHolder nproperties)

The next_n operation returns true if an item exists at the current position in the iterator and the how_many parameter was set greater than zero. The output is a PropertyNames sequence with at most the how_many number of names. A return of false signifies no more items in the iterator.

Parameters:

how_many - the number of properties to retrieve.

nproperties - the sequence of retrieved properties is returned in the output parameter.

Returns:

true if at least one property was retrieved.

destroy

void destroy()

The destroy operation destroys the iterator.