OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.FileList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fl.hasNext()) {
                          File file = fl.getNextFile();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fl.hasNext()) {
                          File[] files = fl.getNextFiles(fl.available());
                     }
                     
                                 
                     
                
MethodgetNextFile
Description

Gets the next File in this list.

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

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

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