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