OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SystemNodeList
Implementsosid.OsidList
Used Byosid.control.SystemNode
Description

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

while (snl.hasNext()) {
     SystemNode node = snl.getNextSystemNode();
}
                
or
while (snl.hasNext()) {
     SystemNode[] nodes = snl.getNextSystemNodes(snl.available());
}
                

Like all OsidLists, SystemNodeList is stateful and must not be accessed by multiple processing threads.

MethodgetNextSystemNode
Description

Gets the next SystemNode in this list.

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

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

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