OSID Logo
OSID Specifications
relationship batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.batch.RelationshipPeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rpl.hasNext()) {
                          RelationshipPeer peer = rfl.getNextRelationshipPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rpl.hasNext()) {
                          RelationshipPeer[] peers = rpl.getNextRelationshipPeer(rpl.available());
                     }
                     
                                 
                     
                
MethodgetNextRelationshipPeer
Description

Gets the next RelationshipPeer in this list.

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

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

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