OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.DeviceEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (del.hasNext()) {
                          DeviceEnabler enabler = del.getNextDeviceEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (duel.hasNext()) {
                          DeviceEnabler[] enablers = del.getNextDeviceEnablers(del.available());
                     }
                     
                                 
                     
                
MethodgetNextDeviceEnabler
Description

Gets the next DeviceEnabler in this list.

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

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

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