OSID Logo
OSID Specifications
provisioning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.DistributorNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dnl.hasNext()) {
                          DistributorNode node = dnl.getNextDistributorNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dnl.hasNext()) {
                          DistributorNode[] nodes = dnl.getNextDistributorNodes(dnl.available());
                     }
                     
                                 
                     
                
MethodgetNextDistributorNode
Description

Gets the next DistributorNode in this list.

Returnosid.provisioning.DistributorNodethe next DistributorNode in this list. The hasNext() method should be used to test that a next DistributorNode is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextDistributorNodes
Description

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

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