OSID Logo
OSID Specifications
topology rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.rules.EdgeEnablerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (eel.hasNext()) {
                          EdgeEnabler enabler = eel.getNextEdgeEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (eel.hasNext()) {
                          EdgeEnabler[] enablers = eel.getNextEdgeEnablers(eel.available());
                     }
                     
                                 
                     
                
MethodgetNextEdgeEnabler
Description

Gets the next EdgeEnabler in this list.

Returnosid.topology.rules.EdgeEnablerthe next EdgeEnabler in this list. The hasNext() method should be used to test that a next EdgeEnabler is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextEdgeEnablers
Description

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

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