Interface CampusBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface CampusBatchFormList
extends OsidList

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

while (cbfl.hasNext()) {
     CampusBatchForm form = cbfl.getNextCampusBatchForm();
}            
  

or

while (cbfl.hasNext()) {
     CampusBatchForm[] forms = cbfl.getNextCampusBatchForms(cbfl.available());
}            
  

Method Summary

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

getNextCampusBatchForm

CampusBatchForm getNextCampusBatchForm()
                                throws OperationFailedException

Gets the next CampusBatchForm in this list.

Returns:

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

getNextCampusBatchForms

CampusBatchForm[] getNextCampusBatchForms(long n)
                                   throws OperationFailedException

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

Parameters:

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

Returns:

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