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

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

                     
                     
                     while (al.hasNext()) {
                          Activity activity = al.getNextActivity();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (al.hasNext()) {
                          Activity[] activities = al.getNextActivities(al.available());
                     }
                     
                                 
                     
                
MethodgetNextActivity
Description

Gets the next Activity in this list.

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

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

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