OSID Logo
OSID Specifications
subscription batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.batch.SubscriptionBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sbfl.hasNext()) {
                          SubscriptionBatchForm form = sbfl.getNextSubscriptionBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          SubscriptionBatchForm[] forms = sbfl.getNextSubscriptionBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextSubscriptionBatchForm
Description

Gets the next SubscriptionBatchForm in this list.

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

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

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