OSID Logo
OSID Specifications
filing package
Version 3.1.0
Interfaceosid.filing.FileList
Implementsosid.OsidList
Used Byosid.filing.FileLookupSession
osid.filing.FileQuerySession
osid.filing.FileSearchResults
osid.filing.FileSystemSession
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.File the next File in this list. The hasNext() method should be used to test that a next File 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.
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().

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