Interface SummaryList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

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()) {
     Summary summary = sl.getNextSummary();
}            
  

or

while (sl.hasNext()) {
     Summary[] summaries = sl.getNextSummaries(sl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Summary[]	getNextSummaries(long n)	Gets the next set of Summary elements in this list.
Summary	getNextSummary()	Gets the next Summary in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextSummary

Summary getNextSummary()
                throws OperationFailedException

Gets the next Summary in this list.

Returns:

the next Summary in this list. The hasNext() method should be used to test that a next Summary is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextSummaries

Summary[] getNextSummaries(long n)
                    throws OperationFailedException

Gets the next set of Summary elements in this list. The specified amount must be less than or equal to the return from available() .

Parameters:

n - the number of Summary elements requested which must be less than or equal to available()

Returns:

an array of Summary elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.