Interface AppointmentBatchFormList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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 Details

    • 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.