OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceRelationshipPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rrpl.hasNext()) {
                          ResourceRelationshipPeer peer = rrpl.getNextResourceRelationshiPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rrpl.hasNext()) {
                          ResourceRelationshipPeer[] peers = rrpl.getNextResourceRelationshipPeers(rrpl.available());
                     }
                     
                                 
                     
                
MethodgetNextResourceRelationshipPeer
Description

Gets the next ResourceRelationshipPeer in this list.

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

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

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