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