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