org.osid.learning

Interface ProficiencyList

All Superinterfaces:

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

public interface ProficiencyList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Proficiency proficiency = pl.getNextProficiency();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Proficiency[] proficiencies = pl.getNextProficiencies(pl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProficiency

Proficiency getNextProficiency()
                               throws OperationFailedException

Gets the next Proficiency in this list.

Returns:

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

getNextProficiencies

Proficiency[] getNextProficiencies(long n)
                                   throws OperationFailedException

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

Parameters:

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

Returns:

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