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

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

                     
                     
                     while (crl.hasNext()) {
                          CreateResponse response = crl.getNextCreateResponse();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (crl.hasNext()) {
                          CreateResponse[] responses = crl.getNextCreateResponses(crl.available());
                     }
                     
                                 
                     
                
MethodgetNextCreateResponse
Description

Gets the next CreateResponse in this list.

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

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

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