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