OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.CommissionEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cel.hasNext()) {
                          CommissionEnabler enabler = cel.getNextCommissionEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cel.hasNext()) {
                          CommissionEnabler[] enablers = cel.getNextCommissionEnablers(cel.available());
                     }
                     
                                 
                     
                
MethodgetNextCommissionEnabler
Description

Gets the next CommissionEnabler in this list.

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

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

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