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