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

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

                     
                     
                     while (aapl.hasNext()) {
                          AuthorizationAgentPeer peer = aapl.getNextAuthorizationAgentPeer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (aapl.hasNext()) {
                          AuthorizationAgentPeer[] peers = aapl.getNextAuthorizationAgentPeers(aapl.available());
                     }
                     
                                 
                     
                
MethodgetNextAuthorizationAgentPeer
Description

Gets the next AuthorizationAgentPeer in this list.

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

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

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