org.osid.assessment

Interface BankList

All Superinterfaces:

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

public interface BankList
extends OsidList

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

       
       
       while (bl.hasNext()) {
            Bank bank = bl.getNextBank();
       }
       
                   
       
  

or

       
       
       while (bl.hasNext()) {
            Bank[] banks = bl.getNextBanks(bl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Bank	getNextBank() Gets the next Bank in this list.
Bank[]	getNextBanks(long n) Gets the next set of Bank elements in this list which must be less than or equal to the return 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

getNextBank

Bank getNextBank()
                 throws OperationFailedException

Gets the next Bank in this list.

Returns:

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

getNextBanks

Bank[] getNextBanks(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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