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