| Interface | osid.hold.batch.HoldPeerList | ||
|---|---|---|---|
| Implements | osid.OsidList | ||
| Description |
Like all while (hpl.hasNext()) {
HoldPeer peer = hpl.getNextHoldPeer();
}
or
while (hpl.hasNext()) {
HoldPeer[] peers = hpl.getNextHoldPeers(hpl.available());
}
Like all | ||
| Method | getNextHoldPeer | ||
| Description |
Gets the next | ||
| Return | osid.hold.batch.HoldPeer | the next HoldPeer in this list. The hasNext()
method should be used to test that a next HoldPeer is available
before calling this method. | |
| Errors | ILLEGAL_STATE | no more elements available in this list | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getNextHoldPeers | ||
| Description |
Gets the next set of | ||
| Parameters | cardinal | n | the number of HoldPeer elements requested which must be less
than or equal to available() |
| Return | osid.hold.batch.HoldPeer[] | an array of HoldPeer 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 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |