org.osid.personnel.batch

Interface AppointmentPeerList

All Superinterfaces:

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

public interface AppointmentPeerList
extends OsidList

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

       
       
       while (apl.hasNext()) {
            AppointmentPeer peer = apl.getNextAppointmentPeer();
       }
       
                   
       
  

or

       
       
       while (apl.hasNext()) {
            AppointmentPeer[] peers = apl.getNextAppointmentPeers(apl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAppointmentPeer

AppointmentPeer getNextAppointmentPeer()
                                       throws OperationFailedException

Gets the next AppointmentPeer in this list.

Returns:

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

getNextAppointmentPeers

AppointmentPeer[] getNextAppointmentPeers(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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