OSID Logo
OSID Specifications
room batch package
Version 3.1.0
Interfaceosid.room.batch.CampusBatchFormList
Implementsosid.OsidList
Used Byosid.room.batch.CampusBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     CampusBatchForm form = cbfl.getNextCampusBatchForm();
}
                
or
while (cbfl.hasNext()) {
     CampusBatchForm[] forms = cbfl.getNextCampusBatchForms(cbfl.available());
}
                
MethodgetNextCampusBatchForm
Description

Gets the next CampusBatchForm in this list.

Returnosid.room.batch.CampusBatchForm the next CampusBatchForm in this list. The hasNext() method should be used to test that a next CampusBatchForm 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.
MethodgetNextCampusBatchForms
Description

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

Parameterscardinaln the number of CampusBatchForm elements requested which must be less than or equal to available()
Returnosid.room.batch.CampusBatchForm[] an array of CampusBatchForm 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.