Interface BudgetEntryBatchFormList

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

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

while (bbfl.hasNext()) {
     BudgetEntryBatchForm form = bbfl.getNextBudgetEntryBatchForm();
}
or 
while (bbfl.hasNext()) {
     BudgetEntryBatchForm[] forms = bbfl.getNextBudgetEntryBatchForms(bbfl.available());
}

  • Method Details

    • getNextBudgetEntryBatchForm

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

    • getNextBudgetEntryBatchForms

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