org.osid.personnel.batch

Interface OrganizationBatchFormList

All Superinterfaces:

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

public interface OrganizationBatchFormList
extends OsidList

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

       
       
       while (obfl.hasNext()) {
            OrganizationBatchForm form = obfl.getNextOrganizationBatchForm();
       }
       
                   
       
  

or

       
       
       while (obfl.hasNext()) {
            OrganizationBatchForm[] forms = obfl.getNextOrganizationBatchForms(obfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOrganizationBatchForm

OrganizationBatchForm getNextOrganizationBatchForm()
                                                   throws OperationFailedException

Gets the next OrganizationBatchForm in this list.

Returns:

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

getNextOrganizationBatchForms

OrganizationBatchForm[] getNextOrganizationBatchForms(long n)
                                                      throws OperationFailedException

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

Parameters:

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

Returns:

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