Interface FiscalPeriodBatchFormList

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

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

while (fpbfl.hasNext()) {
     FiscalPeriodBatchForm form = fpbfl.getNextFiscalPeriodBatchForm();
}
or 
while (fpbfl.hasNext()) {
     FiscalPeriodBatchForm[] forms = fpbfl.getNextFiscalPeriodBatchForms(fpbfl.available());
}

  • Method Details

    • getNextFiscalPeriodBatchForm

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

    • getNextFiscalPeriodBatchForms

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