org.osid.authentication.keys.batch

Interface KeyBatchFormList

All Superinterfaces:

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

public interface KeyBatchFormList
extends OsidList

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

       
       
       while (kbfl.hasNext()) {
            KeyBatchForm form = kbfl.getNextKeyBatchForm();
       }
       
                   
       
  

or

       
       
       while (kbfl.hasNext()) {
            KeyBatchForm[] forms = kbfl.getNextKeyBatchForms(kbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextKeyBatchForm

KeyBatchForm getNextKeyBatchForm()
                                 throws OperationFailedException

Gets the next KeyBatchForm in this list.

Returns:

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

getNextKeyBatchForms

KeyBatchForm[] getNextKeyBatchForms(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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