OSID Logo
OSID Specifications
installation package
Version 3.1.0
Interfaceosid.installation.SiteList
Implementsosid.OsidList
Used Byosid.installation.SiteLookupSession
Description

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

while (sl.hasNext()) {
     Site site = sl.getNextSite();
}
                
or
while (sl.hasNext()) {
     Site[] sites = sl.getNextSites(sl.available());
}
                
MethodgetNextSite
Description

Gets the next Site in this list.

Returnosid.installation.Site the next Site in this list. The hasNext() method should be used to test that a next Site 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.
MethodgetNextSites
Description

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

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