Interface BudgetBatchFormList

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

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

while (bbfl.hasNext()) {
     BudgetBatchForm form = bbfl.getNextBudgetBatchForm();
}
or 
while (bbfl.hasNext()) {
     BudgetBatchForm[] forms = bbfl.getNextBudgetBatchForms(bbfl.available());
}

  • Method Details

    • getNextBudgetBatchForm

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

    • getNextBudgetBatchForms

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