OSID Logo
OSID Specifications
repository package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.CompositionList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cl.hasNext()) {
                          Composition composition = cl.getNextComposition();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Composition[] compositions = cl.getNextCompositions(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextComposition
Description

Gets the next Composition in this list.

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

Gets the next set of Composition elements in this list which must be less than or equal to the return from available().

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