org.omg.CosPropertyService
Interface PropertyNamesIteratorOperations

All Known Subinterfaces:

PropertyNamesIterator

All Known Implementing Classes:

_PropertyNamesIteratorStub, PropertyNamesIteratorImpl, PropertyNamesIteratorPOA, PropertyNamesIteratorPOATie

public interface PropertyNamesIteratorOperations

A PropertySet maintains a set of name-value pairs. The get_all_property_names operation returns a sequence of names (PropertyNames). If there are additional names, the get_all_property_names operation returns an object supporting the PropertyNamesIterator interface with the additional names.

The PropertyNamesIterator interface allows a client to iterate through the names using the next_one or next_n operations.

Method Summary

void	destroy() The destroy operation destroys the iterator.
boolean	next_n(int how_many, PropertyNamesHolder property_names) 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(org.omg.CORBA.StringHolder property_name) The next_one operation returns true if an item exists at the current position in the iterator with an output parameter of a property.
void	reset() The reset operation resets the position in an iterator to the first property, if one exists.

Method Detail

reset

void reset()

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

next_one

boolean next_one(org.omg.CORBA.StringHolder property_name)

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

Parameters:

property_name - the retrieved property name is returned in the output parameter.

Returns:

true if a property name was retrieved.

next_n

boolean next_n(int how_many,
               PropertyNamesHolder property_names)

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 properties sequence with at most the how_many number of properties. A return of false signifies no more items in the iterator.

Parameters:

how_many - the number of property names to retrieve.

property_names - the sequence of retrieved property names is returned in the output parameter.

Returns:

true if at least one property name was retrieved.

destroy

void destroy()

The destroy operation destroys the iterator.