org.osid.resource.batch

Interface ResourceRelationshipBatchFormList

All Superinterfaces:

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

public interface ResourceRelationshipBatchFormList
extends OsidList

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

       
       
       while (rrbfl.hasNext()) {
            ResourceRelationshipBatchForm form = rrbfl.getNextResourceRelationshipBatchForm();
       }
       
                   
       
  

or

       
       
       while (rrbfl.hasNext()) {
            ResourceRelationshipBatchForm[] forms = rrbfl.getNextResourceRelationshipBatchForms(rrbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextResourceRelationshipBatchForm

ResourceRelationshipBatchForm getNextResourceRelationshipBatchForm()
                                                                   throws OperationFailedException

Gets the next ResourceRelationshipBatchForm in this list.

Returns:

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

getNextResourceRelationshipBatchForms

ResourceRelationshipBatchForm[] getNextResourceRelationshipBatchForms(long n)
                                                                      throws OperationFailedException

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

Parameters:

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

Returns:

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