org.osid.resourcing

Interface CommissionList

All Superinterfaces:

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

public interface CommissionList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Commission commission = cl.getNextCommission();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Commission[] commissions = cl.getNextCommissions(cl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Commission	getNextCommission() Gets the next Commission in this list.
Commission[]	getNextCommissions(long n) Gets the next set of Commission 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

getNextCommission

Commission getNextCommission()
                             throws OperationFailedException

Gets the next Commission in this list.

Returns:

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

getNextCommissions

Commission[] getNextCommissions(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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