Interface RenovationBatchFormList

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

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

while (rbfl.hasNext()) {
     RenovationBatchForm form = rbfl.getNextRenovationBatchForm();
}
or 
while (rbfl.hasNext()) {
     RenovationBatchForm[] forms = rbfl.getNextRenovationBatchForms(rbfl.available());
}

  • Method Details

    • getNextRenovationBatchForm

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

    • getNextRenovationBatchForms

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