OSID Logo
OSID Specifications
relationship batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.relationship.batch.FamilyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fbfl.hasNext()) {
                          FamilyBatchForm form = fbfl.getNextFamilyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fbfl.hasNext()) {
                          FamilyBatchForm[] forms = fbfl.getNextFamilyBatchForms(fbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextFamilyBatchForm
Description

Gets the next FamilyBatchForm in this list.

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

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

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