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

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

                     
                     
                     while (lsl.hasNext()) {
                          Signal signal = sl.getNextSignal();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Signal[] signals = sl.getNextSignals(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextSignal
Description

Gets the next Signal in this list.

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

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

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