public interface DirectionBatchFormList extends OsidList
Like all OsidLists,
DirectionBatchFormList
provides a means for accessing DirectionBatchForm
elements sequentially either one at a time or many at a time. Examples:
while (dbfl.hasNext()) { DirectionBatchForm form = dbfl.getNextDirectionBatchForm(); }or
while (dbfl.hasNext()) { DirectionBatchForm[] forms = dbfl.getNextDirectionBatchForms(dbfl.available()); }
Modifier and Type | Method and Description |
---|---|
DirectionBatchForm |
getNextDirectionBatchForm()
Gets the next
DirectionBatchForm in this list. |
DirectionBatchForm[] |
getNextDirectionBatchForms(long n)
Gets the next set of
DirectionBatchForm elements in
this list. |
DirectionBatchForm getNextDirectionBatchForm() throws OperationFailedException
DirectionBatchForm
in this list. DirectionBatchForm
in this list. The
hasNext()
method should be used to test that a
next DirectionBatchForm
is available before
calling this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DirectionBatchForm[] getNextDirectionBatchForms(long n) throws OperationFailedException
DirectionBatchForm
elements in
this list. The specified amount must be less than or equal to the
return from available().
n
- the number of DirectionBatchForm
elements
requested which must be less than or equal to
available()
DirectionBatchForm
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.