Interface CourseBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface CourseBatchFormList
extends OsidList

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

while (cbfl.hasNext()) {
     CourseBatchForm form = cbfl.getNextCourseBatchForm();
}            
  

or

while (cbfl.hasNext()) {
     CourseBatchForm[] forms = cbfl.getNextCourseBatchForms(cbfl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
CourseBatchForm	getNextCourseBatchForm()	Gets the next CourseBatchForm in this list.
CourseBatchForm[]	getNextCourseBatchForms(long n)	Gets the next set of CourseBatchForm elements in this list.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextCourseBatchForm

CourseBatchForm getNextCourseBatchForm()
                                throws OperationFailedException

Gets the next CourseBatchForm in this list.

Returns:

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

getNextCourseBatchForms

CourseBatchForm[] getNextCourseBatchForms(long n)
                                   throws OperationFailedException

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

Parameters:

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

Returns:

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