OSID Logo
OSID Specifications
sequencing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.sequencing.AntimatroidNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (anl.hasNext()) {
                          AntimatroidNode node = anl.getNextAntimatroidNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (anl.hasNext()) {
                          AntimatroidNode[] nodes = anl.getNextAntimatroidNodes(anl.available());
                     }
                     
                                 
                     
                
MethodgetNextAntimatroidNode
Description

Gets the next AntimatroidNode in this list.

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

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

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