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