OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.DeviceList
Implementsosid.OsidList
Used Byosid.control.DeviceLookupSession
osid.control.DeviceQuerySession
osid.control.DeviceSearchResults
osid.control.DeviceSystemSession
osid.control.rules.DeviceEnablerRuleLookupSession
Description

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

while (dl.hasNext()) {
     Device device = dl.getNextDevice();
}
                
or
while (dl.hasNext()) {
     Device[] devices = dl.getNextDevices(dl.available());
}
                
MethodgetNextDevice
Description

Gets the next Device in this list.

Returnosid.control.Device the next Device in this list. The hasNext() method should be used to test that a next Device 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.
MethodgetNextDevices
Description

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

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