org.osid.resourcing

Interface CompetencyList

All Superinterfaces:

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

public interface CompetencyList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Competency competency = cl.getNextCompetency();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Competency[] competencies = cl.getNextCompetencies(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCompetency

Competency getNextCompetency()
                             throws OperationFailedException

Gets the next Competency in this list.

Returns:

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

getNextCompetencies

Competency[] getNextCompetencies(long n)
                                 throws OperationFailedException

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

Parameters:

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

Returns:

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