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

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

                     
                     
                     while (al.hasNext()) {
                          Asset asset = al.getNextAsset();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Asset[] assets = al.getNextAssets(al.available());
                     }
                     
                                 
                     
                
MethodgetNextAsset
Description

Gets the next Asset in this list.

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

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

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