OSID Logo
OSID Specifications
transaction package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transaction.batch.DeleteResponseList
Implementsosid.OsidList
Description

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

                     
                     
                     while (drl.hasNext()) {
                          DeleteResponse response = bdrl.getNextDeleteResponse();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (drl.hasNext()) {
                          DeleteResponse[] responses = drl.getNextDeleteResponses(drl.available());
                     }
                     
                                 
                     
                
MethodgetNextDeleteResponse
Description

Gets the next hDeleteResponse in this list.

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

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

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