OSID Logo
OSID Specifications
billing payment package
Version 3.1.0
Interfaceosid.billing.payment.SummaryList
Implementsosid.OsidList
Used Byosid.billing.payment.SummarySession
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()) {
     Symmary summary = sl.getNextSummary();
}
                
or
while (sl.hasNext()) {
     Summary[] summaries = sl.getNextSummaries(sl.available());
}
                
MethodgetNextSummary
Description

Gets the next Summary in this list.

Returnosid.billing.payment.Summary the next Summary in this list. The hasNext() method should be used to test that a next Summary is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the number of Summary elements requested which must be less than or equal to available()
Returnosid.billing.payment.Summary[] an array of Summary elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.