OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SystemList
Implementsosid.OsidList
Used Byosid.control.ActionGroupSystemSession
osid.control.ControllerSystemSession
osid.control.DeviceSystemSession
osid.control.InputSystemSession
osid.control.SceneSystemSession
osid.control.SettingSystemSession
osid.control.SystemHierarchySession
osid.control.SystemLookupSession
osid.control.SystemQuerySession
osid.control.SystemSearchResults
show 5 more…
osid.control.TriggerSystemSession
osid.control.rules.ActionEnablerSystemSession
osid.control.rules.DeviceEnablerSystemSession
osid.control.rules.InputEnablerSystemSession
osid.control.rules.TriggerEnablerSystemSession
Description

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

while (sl.hasNext()) {
     System system = sl.getNextSystem();
}
                
or
while (sl.hasNext()) {
     System[] systems = sl.getNextSystems(sl.available());
}
                
MethodgetNextSystem
Description

Gets the next System in this list.

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

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

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