OSID Logo
OSID Specifications
topology batch package
Version 3.1.0
Interfaceosid.topology.batch.EdgePeerList
Implementsosid.OsidList
Description

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

while (epl.hasNext()) {
     EdgePeer peer = epl.getNextEdgePeer();
}
                
or
while (epl.hasNext()) {
     EdgePeer[] peers = epl.getNextEdgePeer(epl.available());
}
                
MethodgetNextEdgePeer
Description

Gets the next EdgePeer in this list.

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

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

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