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

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

                     
                     
                     while (cupl.hasNext()) {
                          CanonicalUnitProcessor = cupl.getNextCanonicalUnitProcessor();
                     }
                     
                                 
                     
                
or
                     
                     
                     while cuapl.hasNext()) {
                          CanonicalUnitProcessor[] = cupl.getNextCanonicalUnitProcessors(cupl.available());
                     }
                     
                                 
                     
                
MethodgetNextCanonicalUnitProcessor
Description

Gets the next CanonicalUnitProcessor in this list.

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

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

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