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()); }
Modifier and Type | Method and Description |
---|---|
DictionaryBatchForm |
getNextDictionaryBatchForm()
Gets the next
DictionaryBatchForm in this list. |
DictionaryBatchForm[] |
getNextDictionaryBatchForms(long n)
Gets the next set of
DictionaryBatchForm elements in
this list. |
DictionaryBatchForm getNextDictionaryBatchForm() throws OperationFailedException
DictionaryBatchForm
in this list. DictionaryBatchForm
in this list. The
hasNext()
method should be used to test that a
next DictionaryBatchForm
is available before
calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DictionaryBatchForm[] getNextDictionaryBatchForms(long n) throws OperationFailedException
DictionaryBatchForm
elements in
this list. The specified amount must be less than or equal to the
return from available().
n
- the number of DictionaryBatchForm
elements
requested which must be less than or equal to
available()
DictionaryBatchForm
elements.
The length of the array is less than or equal
to the number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.