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