Interface TimePeriodBatchFormList

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

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

while (tpbfl.hasNext()) {
     TimePeriodBatchForm form = tpbfl.getNextTimePeriodBatchForm();
}
or 
while (tpbfl.hasNext()) {
     TimePeriodBatchForm[] forms = tpbfl.getNextTimePeriodBatchForms(tpbfl.available());
}

  • Method Details

    • getNextTimePeriodBatchForm

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

    • getNextTimePeriodBatchForms

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