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

Like all OsidLists,

                     
                     
                     AliasResponseList
                     
                                 
                     
                
provides a means for accessing AliasResponse elements sequentially either one at a time or many at a time. Examples:

                     
                     
                     while arl.hasNext()) {
                          AliasResponse response = arl.getNextAliasResponse();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (arl.hasNext()) {
                          AliasResponse[] responses = arl.getNextAliasResponses(arl.available());
                     }
                     
                                 
                     
                
MethodgetNextAliasResponse
Description

Gets the next AliasResponse in this list.

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

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

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