org.osid.authorization.batch

Interface AuthorizationAgentPeerList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface AuthorizationAgentPeerList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationAgentPeer	getNextAuthorizationAgentPeer() Gets the next AuthorizationAgentPeer in this list.
AuthorizationAgentPeer[]	getNextAuthorizationAgentPeers(long n) Gets the next set of AuthorizationAgentPeer elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextAuthorizationAgentPeer

AuthorizationAgentPeer getNextAuthorizationAgentPeer()
                                                     throws OperationFailedException

Gets the next AuthorizationAgentPeer in this list.

Returns:

the next AuthorizationAgentPeer in this list. The hasNext() method should be used to test that a next AuthorizationAgentPeer is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextAuthorizationAgentPeers

AuthorizationAgentPeer[] getNextAuthorizationAgentPeers(long n)
                                                        throws OperationFailedException

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

Parameters:

n - the number of AuthorizationAgentPeer elements requested which must be less than or equal to available()

Returns:

an array of AuthorizationAgentPeer elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.