OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.VaultBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (vbfl.hasNext()) {
                          VaultBatchForm form = vbfl.getNextVaultBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (vbfl.hasNext()) {
                          VaultBatchForm[] forms = vbfl.getNextVaultBatchForms(vbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextVaultBatchForm
Description

Gets the next VaultBatchForm in this list.

Returnosid.authorization.batch.VaultBatchFormthe next VaultBatchForm in this list. The hasNext() method should be used to test that a next VaultBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextVaultBatchForms
Description

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

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