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