OSID Logo
OSID Specifications
course chronicle batch package
Version 3.1.0
Interfaceosid.course.chronicle.batch.CredentialEntryBatchFormList
Implementsosid.OsidList
Used Byosid.course.chronicle.batch.CredentialEntryBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     CredentialEntryBatchForm form = cbfl.getNextCredentialEntryBatchForm();
}
                
or
while (cbfl.hasNext()) {
     CredentialEntryBatchForm[] forms = cbfl.getNextCredentialEntryBatchForms(cbfl.available());
}
                
MethodgetNextCredentialEntryBatchForm
Description

Gets the next CredentialEntryBatchForm in this list.

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

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

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