OSID Logo
OSID Specifications
acknowledgement package
Version 3.1.0
Interfaceosid.acknowledgement.CreditList
Implementsosid.OsidList
Used Byosid.acknowledgement.CreditBillingSession
osid.acknowledgement.CreditLookupSession
osid.acknowledgement.CreditQuerySession
osid.acknowledgement.CreditSearchResults
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.Credit the next Credit in this list. The hasNext() method should be used to test that a next Credit 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.