OSID Logo
OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
Interfaceosid.PropertyList
Implementsosid.OsidList
Description

Like all OsidLists, PropertyList provides a means for accessing Property elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (pl.hasNext()) {
                          Property property = pl.getNextProperty();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Property[] properties = pl.getNextProperties(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextProperty
Description

Gets the next Property in this list.

Returnosid.Propertythe next Property in this list. The hasNext() method should be used to test that a next Property is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextProperties
Description

Gets the next set of Property elements in this list which must be less than or equal to the number returned from available().

Parameterscardinalnthe number of Property elements requested which should be less than or equal to available()
Returnosid.Property[]an array of Property elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.