Interface AgencyList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface AgencyList
extends OsidList

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

while (al.hasNext()) {
     Agency agency = al.getNextAgency();
}            
  

or

while (al.hasNext()) {
     Agency[] agencies = al.getNextAgencies(al.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Agency[]	getNextAgencies(long n)	Gets the next set of Agency elements in this list which must be less than or equal to the return from available() .
Agency	getNextAgency()	Gets the next Agency in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextAgency

Agency getNextAgency()
              throws OperationFailedException

Gets the next Agency in this list.

Returns:

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

getNextAgencies

Agency[] getNextAgencies(long n)
                  throws OperationFailedException

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

Parameters:

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

Returns:

an array of Agency eleme nts. 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.