org.osid.calendaring.batch

Interface SchedulePeerList

All Superinterfaces:

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

public interface SchedulePeerList
extends OsidList

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

       
       
       while (spl.hasNext()) {
            SchedulePeer peer = spl.getNextSchedulePeer();
       }
       
                   
       
  

or

       
       
       while (spl.hasNext()) {
            SchedulePeer[] peers = spl.getNextSchedulePeers(spl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSchedulePeer

SchedulePeer getNextSchedulePeer()
                                 throws OperationFailedException

Gets the next SchedulePeer in this list.

Returns:

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

getNextSchedulePeers

SchedulePeer[] getNextSchedulePeers(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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