OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.DeedList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dl.hasNext()) {
                         Deed = dl.getNextDeed();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dl.hasNext()) {
                         Deed[] deeds = dl.getNextDeeds(dl.available());
                     }
                     
                                 
                     
                
MethodgetNextDeed
Description

Gets the next Deed in this list.

Returnosid.room.squatting.Deedthe next Deed in this list. The hasNext() method should be used to test that a next Deed is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextDeeds
Description

Gets the next set of Deed elements in this list. The specified amount must be less than or equal to the return from available().

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