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