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

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

                     
                     
                     while (dpl.hasNext()) {
                          DeedPeer peer = dpl.getNextDeedPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dpl.hasNext()) {
                          DeedPeer[] peers = dpl.getNextDeedPeers(dpl.available());
                     }
                     
                                 
                     
                
MethodgetNextDeedPeer
Description

Gets the next DeedPeer in this list.

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

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

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