OSID Logo
OSID Specifications
financials package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.SummaryList
Implementsosid.OsidList
Description

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());
                     }
                     
                                 
                     
                
MethodgetNextSummary
Description

Gets the next Summary in this list.

Returnosid.financials.Summarythe next Summary in this list. The hasNext() method should be used to test that a next Summary is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextSummaries
Description

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

Parameterscardinalnthe number of Summary elements requested which must be less than or equal to available()
Returnosid.financials.Summary[]an array of Summary elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.