OSID Logo
OSID Specifications
mapping path rules package
Version 3.1.0
Interfaceosid.mapping.path.rules.SignalEnablerList
Implementsosid.OsidList
Used Byosid.mapping.path.rules.SignalEnablerLookupSession
osid.mapping.path.rules.SignalEnablerMapSession
osid.mapping.path.rules.SignalEnablerQuerySession
osid.mapping.path.rules.SignalEnablerRuleLookupSession
osid.mapping.path.rules.SignalEnablerSearchResults
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.SignalEnabler the next SignalEnabler in this list. The hasNext() method should be used to test that a next SignalEnabler 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.