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