OSID Logo
OSID Specifications
resource batch package
Version 3.1.0
Interfaceosid.resource.batch.ResourceRelationshipBatchFormList
Implementsosid.OsidList
Used Byosid.resource.batch.ResourceRelationshipBatchAdminSession
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.ResourceRelationshipBatchForm the next ResourceRelationshipBatchForm in this list. The hasNext() method should be used to test that a next ResourceRelationshipBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.