Interface CourseOfferingBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface CourseOfferingBatchFormList
extends OsidList

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

while (cobfl.hasNext()) {
     CourseOfferingBatchForm form = cobfl.getNextCourseOfferingBatchForm();
}            
  

or

while (cobfl.hasNext()) {
     CourseOfferingBatchForm[] forms = cobfl.getNextCourseOfferingBatchForms(cobfl.available());
}            
  

Method Summary

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

getNextCourseOfferingBatchForm

CourseOfferingBatchForm getNextCourseOfferingBatchForm()
                                                throws OperationFailedException

Gets the next CourseOfferingBatchForm in this list.

Returns:

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

getNextCourseOfferingBatchForms

CourseOfferingBatchForm[] getNextCourseOfferingBatchForms(long n)
                                                   throws OperationFailedException

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

Parameters:

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

Returns:

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