OSID - osid.relationship.batch.RelationshipPeerList Service Interface Definition

Interface	osid.relationship.batch.RelationshipPeerList
Implements	`osid.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()); }
Method	getNextRelationshipPeer
Description	Gets the next `RelationshipPeer` in this list.
Return	`osid.relationship.batch.RelationshipPeer`		the next `RelationshipPeer` in this list. The `hasNext()` method should be used to test that a next `RelationshipPeer` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextRelationshipPeers
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()`.
Parameters	`cardinal`	`n`	the number of `RelationshipPeer` elements requested which must be less than or equal to `available()`
Return	`osid.relationship.batch.RelationshipPeer[]`		an array of `RelationshipPeer` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.