OSID Logo
OSID Specifications
ontology batch package
Version 3.1.0
Interfaceosid.ontology.batch.SubjectBatchFormList
Implementsosid.OsidList
Used Byosid.ontology.batch.SubjectBatchAdminSession
Description

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

while (sbfl.hasNext()) {
     SubjectBatchForm form = sbfl.getNextSubjectBatchForm();
}
                
or
while (sbfl.hasNext()) {
     SubjectBatchForm[] forms = sbfl.getNextSubjectBatchForms(sbfl.available());
}
                
MethodgetNextSubjectBatchForm
Description

Gets the next SubjectBatchForm in this list.

Returnosid.ontology.batch.SubjectBatchForm the next SubjectBatchForm in this list. The hasNext() method should be used to test that a next SubjectBatchForm 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.
MethodgetNextSubjectBatchForms
Description

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

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