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