OSID Logo
OSID Specifications
hold batch package
Version 3.1.0
Interfaceosid.hold.batch.OublietteBatchFormList
Implementsosid.OsidList
Used Byosid.hold.batch.OublietteBatchAdminSession
Description

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

while (obfl.hasNext()) {
     OublietteBatchForm form = obfl.getNextOublietteBatchForm();
}
                
or
while (obfl.hasNext()) {
     OublietteBatchForm[] forms = obfl.getNextOublietteBatchForms(obfl.available());
}
                
MethodgetNextOublietteBatchForm
Description

Gets the next OublietteBatchForm in this list.

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

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

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