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