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

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

                     
                     
                     while (url.hasNext()) {
                          UpdateResponse response = url.getNextUpdateResponse();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (url.hasNext()) {
                          UpdateResponse[] responses = url.getNextUpdateResponses(url.available());
                     }
                     
                                 
                     
                
MethodgetNextUpdateResponse
Description

Gets the next UpdateResponse in this list.

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

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

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