org.osid.tracking.batch

Interface IssuePeerList

All Superinterfaces:

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

public interface IssuePeerList
extends OsidList

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

       
       
       while (ipl.hasNext()) {
            IssuePeer peer = ipl.getNextIssuePeer();
       }
       
                   
       
  

or

       
       
       while (ipl.hasNext()) {
            IssuePeer[] peers = ipl.getNextIssuePeers(ipl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
IssuePeer	getNextIssuePeer() Gets the next IssuePeer in this list.
IssuePeer[]	getNextIssuePeers(long n) Gets the next set of IssuePeer 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

getNextIssuePeer

IssuePeer getNextIssuePeer()
                           throws OperationFailedException

Gets the next IssuePeer in this list.

Returns:

the next IssuePeer in this list. The hasNext() method should be used to test that a next IssuePeer 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.

getNextIssuePeers

IssuePeer[] getNextIssuePeers(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

an array of IssuePeer 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.