org.osid.personnel.batch

Interface RealmBatchFormList

All Superinterfaces:

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

public interface RealmBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            RealmBatchForm form = rbfl.getNextRealmBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            RealmBatchForm[] forms = rbfl.getNextRealmBatchForms(rbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRealmBatchForm

RealmBatchForm getNextRealmBatchForm()
                                     throws OperationFailedException

Gets the next RealmBatchForm in this list.

Returns:

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

getNextRealmBatchForms

RealmBatchForm[] getNextRealmBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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