Interface PeriodBatchFormList

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

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

while (pbfl.hasNext()) {
     PeriodBatchForm form = pbfl.getNextPeriodBatchForm();
}
or 
while (pbfl.hasNext()) {
     PeriodBatchForm[] forms = pbfl.getNextPeriodBatchForms(pbfl.available());
}

  • Method Details

    • getNextPeriodBatchForm

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

    • getNextPeriodBatchForms

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