Interface ProgramOfferingBatchFormList

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

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

while (pobfl.hasNext()) {
     ProgramOfferingBatchForm form = pobfl.getNextProgramOfferingBatchForm();
}
or 
while (pobfl.hasNext()) {
     ProgramOfferingBatchForm[] forms = pobfl.getNextProgramOfferingBatchForms(pobfl.available());
}

  • Method Details

    • getNextProgramOfferingBatchForm

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

    • getNextProgramOfferingBatchForms

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