Interface FrontOfficeBatchFormList

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

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

while (fbfl.hasNext()) {
     FrontOfficeBatchForm form = fbfl.getNextFrontOfficeBatchForm();
}
or 
while (fbfl.hasNext()) {
     FrontOfficeBatchForm[] forms = fbfl.getNextFrontOfficeBatchForms(fbfl.available());
}

  • Method Details

    • getNextFrontOfficeBatchForm

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

    • getNextFrontOfficeBatchForms

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