org.osid.control.batch

Interface SceneBatchFormList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface SceneBatchFormList
extends OsidList

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

       
       
       while (sbfl.hasNext()) {
            SceneBatchForm form = sbfl.getNextSceneBatchForm();
       }
       
                   
       
  

or

       
       
       while (sbfl.hasNext()) {
            SceneBatchForm[] forms = sbfl.getNextSceneBatchForms(sbfl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
SceneBatchForm	getNextSceneBatchForm() Gets the next SceneBatchForm in this list.
SceneBatchForm[]	getNextSceneBatchForms(long n) Gets the next set of SceneBatchForm elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextSceneBatchForm

SceneBatchForm getNextSceneBatchForm()
                                     throws OperationFailedException

Gets the next SceneBatchForm in this list.

Returns:

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

getNextSceneBatchForms

SceneBatchForm[] getNextSceneBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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