OSID Logo
OSID Specifications
offering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.CanonicalUnitList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cul.hasNext()) {
                          CanonicalUnit canonical = cul.getNextCanonicalUnit();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cul.hasNext()) {
                          CanonicalUnit[] canonicals = cul.getNextCanonicalUnits(cul.available());
                     }
                     
                                 
                     
                
MethodgetNextCanonicalUnit
Description

Gets the next CanonicalUnit in this list.

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

Gets the next set of CanonicalUnit elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinalnthe number of CanonicalUnit elements requested which must be less than or equal to available()
Returnosid.offering.CanonicalUnit[]an array of CanonicalUnit 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.