org.osid.relationship.batch

Interface RelationshipBatchFormList

All Superinterfaces:

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

public interface RelationshipBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            RelationshipBatchForm form = rbfl.getNextRelationshipBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            RelationshipBatchForm[] forms = rbfl.getNextRelationshipBatchForms(rbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRelationshipBatchForm

RelationshipBatchForm getNextRelationshipBatchForm()
                                                   throws OperationFailedException

Gets the next RelationshipBatchForm in this list.

Returns:

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

getNextRelationshipBatchForms

RelationshipBatchForm[] getNextRelationshipBatchForms(long n)
                                                      throws OperationFailedException

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

Parameters:

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

Returns:

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