Interface ProgramEntryBatchFormList

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

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

while (pbfl.hasNext()) {
     ProgramEntryBatchForm form = pbfl.getNextProgramEntryBatchForm();
}
or 
while (pbfl.hasNext()) {
     ProgramEntryBatchForm[] forms = pbfl.getNextProgramEntryBatchForms(pbfl.available());
}

  • Method Details

    • getNextProgramEntryBatchForm

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

    • getNextProgramEntryBatchForms

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