org.osid.resource

Interface ResourceRelationshipList

All Superinterfaces:

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

public interface ResourceRelationshipList
extends OsidList

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

       
       
       while (rrl.hasNext()) {
            ResourceRelationship relationship = rrl.getNextResourceRelationship();
       }
       
                   
       
  

or

       
       
       while (rrl.hasNext()) {
            ResourceRelationship[] relationships = rrl.getNextResourceRelationships(rrl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ResourceRelationship	getNextResourceRelationship() Gets the next ResourceRelationship in this list.
ResourceRelationship[]	getNextResourceRelationships(long n) Gets the next set of ResourceRelationship elements in this list which must be less than or equal to the number returned from available().

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

getNextResourceRelationship

ResourceRelationship getNextResourceRelationship()
                                                 throws OperationFailedException

Gets the next ResourceRelationship in this list.

Returns:

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

getNextResourceRelationships

ResourceRelationship[] getNextResourceRelationships(long n)
                                                    throws OperationFailedException

Gets the next set of ResourceRelationship elements in this list which must be less than or equal to the number returned from available().

Parameters:

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

Returns:

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