org.osid.financials

Interface SummaryList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

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.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.