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

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

                     
                     
                     while (dl.hasNext()) {
                          Directory directory = dl.getNextDirectory();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dl.hasNext()) {
                          Directory[] directories = dl.getNextDirectories(dl.available());
                     }
                     
                                 
                     
                
MethodgetNextDirectory
Description

Gets the next Directory in this list.

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

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

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