org.osid.workflow.batch

Interface OfficeBatchFormList

All Superinterfaces:

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

public interface OfficeBatchFormList
extends OsidList

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

       
       
       while (obfl.hasNext()) {
            OfficeBatchForm form = obfl.getNextOfficeBatchForm();
       }
       
                   
       
  

or

       
       
       while (obfl.hasNext()) {
            OfficeBatchForm[] forms = obfl.getNextOfficeBatchForms(obfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOfficeBatchForm

OfficeBatchForm getNextOfficeBatchForm()
                                       throws OperationFailedException

Gets the next OfficeBatchForm in this list.

Returns:

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

getNextOfficeBatchForms

OfficeBatchForm[] getNextOfficeBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

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

Returns:

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