org.osid.relationship

Interface RelationshipList

All Superinterfaces:

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

public interface RelationshipList
extends OsidList

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

       
       
       while (rl.hasNext()) {
            Relationship relationship = rl.getNextRelationship();
       }
       
                   
       
  

or

       
       
       while (rl.hasNext()) {
            Relationship[] relationships = rl.getNextRelationships(rl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRelationship

Relationship getNextRelationship()
                                 throws OperationFailedException

Gets the next Relationship in this list.

Returns:

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

getNextRelationships

Relationship[] getNextRelationships(long n)
                                    throws OperationFailedException

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

Parameters:

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

Returns:

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