org.osid.authentication

Interface AgentList

All Superinterfaces:

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

public interface AgentList
extends OsidList

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

       
       
       while (al.hasNext()) {
            Agent agent = al.getNextAgent();
       }
       
                   
       
  

or

       
       
       while (al.hasNext()) {
            Agent[] agents = al.getNextAgents(al.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Agent	getNextAgent() Gets the next Agent in this list.
Agent[]	getNextAgents(long n) Gets the next set of Agent elements in this list which must be less than or equal to the number returned from available().

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

getNextAgent

Agent getNextAgent()
                   throws OperationFailedException

Gets the next Agent in this list.

Returns:

the next Agent in this list. The hasNext() method should be used to test that a next Agent 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.

getNextAgents

Agent[] getNextAgents(long n)
                      throws OperationFailedException

Gets the next set of Agent elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

an array of Agent 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.