OSID Logo
OSID Specifications
acknowledgement package
Version 3.0.0
Release Candidate Preview
Interfaceosid.acknowledgement.CreditList
Implementsosid.OsidList
Description

Like all OsidLists, CreditList provides a means for accessing Credit elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while (cl.hasNext()) {
                          Credit credit = cl.getNextCredit();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Credit[] credits = cl.getNextCredits(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCredit
Description

Gets the next Credit in this list.

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

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

Parameterscardinalnthe number of Credit elements requested which must be less than or equal to available()
Returnosid.acknowledgement.Credit[]an array of Credit 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.