org.osid.contact.batch

Interface ContactBatchFormList

All Superinterfaces:

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

public interface ContactBatchFormList
extends OsidList

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

       
       
       while (cbfl.hasNext()) {
            ContactBatchForm form = cbfl.getNextContactBatchForm();
       }
       
                   
       
  

or

       
       
       while (cbfl.hasNext()) {
            ContactBatchForm[] forms = cbfl.getNextContactBatchForms(cbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextContactBatchForm

ContactBatchForm getNextContactBatchForm()
                                         throws OperationFailedException

Gets the next ContactBatchForm in this list.

Returns:

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

getNextContactBatchForms

ContactBatchForm[] getNextContactBatchForms(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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