org.osid.hold.batch

Interface HoldResourcePeerList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface HoldResourcePeerList
extends OsidList

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

       
       
       while (hrpl.hasNext()) {
            HoldResourcePeer peer = hrpl.getNextHoldResourcePeer();
       }
       
                   
       
  

or

       
       
       while (hrpl.hasNext()) {
            HoldResourcePeer[] peers = hrpl.getNextHoldResourcePeers(hrpl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
HoldResourcePeer	getNextHoldResourcePeer() Gets the next HoldResourcePeer in this list.
HoldResourcePeer[]	getNextHoldResourcePeers(long n) Gets the next set of HoldResourcePeer elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextHoldResourcePeer

HoldResourcePeer getNextHoldResourcePeer()
                                         throws OperationFailedException

Gets the next HoldResourcePeer in this list.

Returns:

the next HoldResourcePeer in this list. The hasNext() method should be used to test that a next HoldResourcePeer is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextHoldResourcePeers

HoldResourcePeer[] getNextHoldResourcePeers(long n)
                                            throws OperationFailedException

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

Parameters:

n - the number of HoldResourcePeer elements requested which must be less than or equal to available()

Returns:

an array of HoldResourcePeer elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.