OSID Logo
OSID Specifications
authentication keys batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.keys.batch.KeyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (kbfl.hasNext()) {
                          KeyBatchForm form = kbfl.getNextKeyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (kbfl.hasNext()) {
                          KeyBatchForm[] forms = kbfl.getNextKeyBatchForms(kbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextKeyBatchForm
Description

Gets the next KeyBatchForm in this list.

Returnosid.authentication.keys.batch.KeyBatchFormthe next KeyBatchForm in this list. The hasNext() method should be used to test that a next KeyBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextKeyBatchForms
Description

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

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