Interface DictionaryBatchFormList

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

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

while (dbfl.hasNext()) {
     DictionaryBatchForm form = dbfl.getNextDictionaryBatchForm();
}
or 
while (dbfl.hasNext()) {
     DictionaryBatchForm[] forms = dbfl.getNextDictionaryBatchForms(dbfl.available());
}

  • Method Details

    • getNextDictionaryBatchForm

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

    • getNextDictionaryBatchForms

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