org.osid.resourcing.batch

Interface CompetencyBatchFormList

All Superinterfaces:

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

public interface CompetencyBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            CompetencyBatchForm form = cbfl.getNextCompetencyBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            CompetencyBatchForm[] forms = cbfl.getNextCompetencyBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextCompetencyBatchForm

CompetencyBatchForm getNextCompetencyBatchForm()
                                               throws OperationFailedException

Gets the next CompetencyBatchForm in this list.

Returns:

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

getNextCompetencyBatchForms

CompetencyBatchForm[] getNextCompetencyBatchForms(long n)
                                                  throws OperationFailedException

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

Parameters:

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

Returns:

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