org.osid.course.syllabus.batch

Interface DocetPeerList

All Superinterfaces:

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

public interface DocetPeerList
extends OsidList

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

       
       
       while (dpl.hasNext()) {
            DocetPeer peer = dpl.getNextDocetPeer();
       }
       
                   
       
  

or

       
       
       while (dpl.hasNext()) {
            DocetPeer[] peers = dpl.getNextDocetPeers(dpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextDocetPeer

DocetPeer getNextDocetPeer()
                           throws OperationFailedException

Gets the next DocetPeer in this list.

Returns:

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

getNextDocetPeers

DocetPeer[] getNextDocetPeers(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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