Interface SyllabusBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface SyllabusBatchFormList
extends OsidList

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

while (sbfl.hasNext()) {
     SyllabusBatchForm form = sbfl.getNextSyllabusBatchForm();
}            
  

or

while (sbfl.hasNext()) {
     SyllabusBatchForm[] forms = sbfl.getNextSyllabusBatchForms(sbfl.available());
}            
  

Method Summary

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

getNextSyllabusBatchForm

SyllabusBatchForm getNextSyllabusBatchForm()
                                    throws OperationFailedException

Gets the next SyllabusBatchForm in this list.

Returns:

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

getNextSyllabusBatchForms

SyllabusBatchForm[] getNextSyllabusBatchForms(long n)
                                       throws OperationFailedException

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

Parameters:

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

Returns:

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