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

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

                     
                     
                     while (rbfl.hasNext()) {
                          RelationshipBatchForm form = rbfl.getNextRelationshipBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RelationshipBatchForm[] forms = rbfl.getNextRelationshipBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRelationshipBatchForm
Description

Gets the next RelationshipBatchForm in this list.

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

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

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