Interface ScheduleSlotBatchFormList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface ScheduleSlotBatchFormList extends OsidList

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

while (ssbfl.hasNext()) {
     ScheduleSlotBatchForm form = ssbfl.getNextScheduleSlotBatchForm();
}
or 
while (ssbfl.hasNext()) {
     ScheduleSlotBatchForm[] forms = ssbfl.getNextScheduleSlotBatchForms(ssbfl.available());
}

  • Method Details

    • getNextScheduleSlotBatchForm

      ScheduleSlotBatchForm getNextScheduleSlotBatchForm() throws OperationFailedException
      Gets the next ScheduleSlotBatchForm in this list.
      Returns:
      the next ScheduleSlotBatchForm in this list. The hasNext() method should be used to test that a next ScheduleSlotBatchForm 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.

    • getNextScheduleSlotBatchForms

      ScheduleSlotBatchForm[] getNextScheduleSlotBatchForms(long n) throws OperationFailedException
      Gets the next set of ScheduleSlotBatchForm elements in this list. The specified amount must be less than or equal to the return from available() .
      Parameters:
      n - the number of ScheduleSlotBatchForm elements requested which must be less than or equal to available()
      Returns:
      an array of ScheduleSlotBatchForm 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.