Interface TriggerBatchFormList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface TriggerBatchFormList
extends OsidList

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

while (tbfl.hasNext()) {
     TriggerBatchForm form = tbfl.getNextTriggerBatchForm();
}            
  

or

while (tbfl.hasNext()) {
     TriggerBatchForm[] forms = tbfl.getNextTriggerBatchForms(tbfl.available());
}            
  

Method Summary

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

getNextTriggerBatchForm

TriggerBatchForm getNextTriggerBatchForm()
                                  throws OperationFailedException

Gets the next TriggerBatchForm in this list.

Returns:

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

getNextTriggerBatchForms

TriggerBatchForm[] getNextTriggerBatchForms(long n)
                                     throws OperationFailedException

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

Parameters:

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

Returns:

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