OSID Logo
OSID Specifications
offering rules package
Version 3.1.0
Interfaceosid.offering.rules.CanonicalUnitProcessorList
Implementsosid.OsidList
Used Byosid.offering.rules.CanonicalUnitProcessorCatalogueSession
osid.offering.rules.CanonicalUnitProcessorEnablerRuleLookupSession
osid.offering.rules.CanonicalUnitProcessorLookupSession
osid.offering.rules.CanonicalUnitProcessorQuerySession
osid.offering.rules.CanonicalUnitProcessorRuleLookupSession
osid.offering.rules.CanonicalUnitProcessorSearchResults
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.CanonicalUnitProcessor the next CanonicalUnitProcessor in this list. The hasNext() method should be used to test that a next CanonicalUnitProcessor is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.