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

Like all OsidLists,

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

                     
                     
                     while arl.hasNext()) {
                          AliasRequest request = arl.getNextAliasRequest();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (arl.hasNext()) {
                          AliasRequest[] requests = arl.getNextAliasRequests(arl.available());
                     }
                     
                                 
                     
                
MethodgetNextAliasRequest
Description

Gets the next AliasRequest in this list.

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

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

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