OSID Logo
OSID Specifications
repository package
Version 3.1.0
Interfaceosid.repository.CompositionList
Implementsosid.OsidList
Used Byosid.repository.AssetCompositionSession
osid.repository.Composition
osid.repository.CompositionLookupSession
osid.repository.CompositionQuerySession
osid.repository.CompositionRepositorySession
osid.repository.CompositionSearchResults
osid.repository.rules.CompositionEnablerRuleLookupSession
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.Composition the next Composition in this list. The hasNext() method should be used to test that a next Composition 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.
MethodgetNextCompositions
Description

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

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.