OSID Logo
OSID Specifications
resource batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.batch.ResourceRelationshipBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (rrbfl.hasNext()) {
                          ResourceRelationshipBatchForm form = rrbfl.getNextResourceRelationshipBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rrbfl.hasNext()) {
                          ResourceRelationshipBatchForm[] forms = rrbfl.getNextResourceRelationshipBatchForms(rrbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextResourceRelationshipBatchForm
Description

Gets the next ResourceRelationshipBatchForm in this list.

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

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

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