OSID Logo
OSID Specifications
course program batch package
Version 3.1.0
Interfaceosid.course.program.batch.CredentialBatchFormList
Implementsosid.OsidList
Used Byosid.course.program.batch.CredentialBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     CredentialBatchForm form = cbfl.getNextCredentialBatchForm();
}
                
or
while (cbfl.hasNext()) {
     CredentialBatchForm[] forms = cbfl.getNextCredentialBatchForms(cbfl.available());
}
                
MethodgetNextCredentialBatchForm
Description

Gets the next CredentialBatchForm in this list.

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

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

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