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

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

                     
                     
                     while (al.hasNext()) {
                          Antimatroid antimatroid = al.getNextAntimatroid();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Antimatroid[] antimatroids = al.getNextAntimatroids(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAntimatroid
Description

Gets the next Antimatroid in this list.

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

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

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