OSID Logo
OSID Specifications
profile batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.batch.ProfileEntryResourcePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (perpl.hasNext()) {
                          ProfileEntryResourcePeer peer = perpl.getNextProfileEntryResourcePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (perpl.hasNext()) {
                          ProfileEntryResourcePeer[] peers = perpl.getNextProfileEntryResourcePeers(perpl.available());
                     }
                     
                                 
                     
                
MethodgetNextProfileEntryResourcePeer
Description

Gets the next ProfileEntryResourcePeer in this list.

Returnosid.profile.batch.ProfileEntryResourcePeerthe next ProfileEntryResourcePeer in this list. The hasNext() method should be used to test that a next ProfileEntryResourcePeer is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextProfileEntryResourcePeers
Description

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

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