org.osid.personnel.batch

Interface AppointmentBatchFormList

All Superinterfaces:

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

public interface AppointmentBatchFormList
extends OsidList

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

       
       
       while (abfl.hasNext()) {
            AppointmentBatchForm form = abfl.getNextAppointmentBatchForm();
       }
       
                   
       
  

or

       
       
       while (abfl.hasNext()) {
            AppointmentBatchForm[] forms = abfl.getNextAppointmentBatchForms(abfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextAppointmentBatchForm

AppointmentBatchForm getNextAppointmentBatchForm()
                                                 throws OperationFailedException

Gets the next AppointmentBatchForm in this list.

Returns:

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

getNextAppointmentBatchForms

AppointmentBatchForm[] getNextAppointmentBatchForms(long n)
                                                    throws OperationFailedException

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

Parameters:

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

Returns:

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