OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.SignalEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sel.hasNext()) {
                          SignalEnabler enabler = sel.getNextSignalEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sel.hasNext()) {
                          SignalEnabler[] enablers = sel.getNextSignalEnablers(sel.available());
                     }
                     
                                 
                     
                
MethodgetNextSignalEnabler
Description

Gets the next SignalEnabler in this list.

Returnosid.mapping.path.rules.SignalEnablerthe next SignalEnabler in this list. The hasNext() method should be used to test that a next SignalEnabler is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextSignalEnablers
Description

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

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