OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.AuthorizationResourcePeerList
Implementsosid.OsidList
Description

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

                     
                     
                     while (arpl.hasNext()) {
                          AuthorizationResourcePeer peer = arpl.getNextAuthorizationResourcePeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (arpl.hasNext()) {
                          AuthorizationResourcePeer[] peers = arpl.getNextAuthorizationResourcePeers(arpl.available());
                     }
                     
                                 
                     
                
MethodgetNextAuthorizationResourcePeer
Description

Gets the next AuthorizationResourcePeer in this list.

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

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

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