org.osid.ontology

Interface SubjectNodeList

All Superinterfaces:

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

public interface SubjectNodeList
extends OsidList

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

       
       
       while (snl.hasNext()) {
            SubjectNode node = snl.getNextSubjectNode();
       }
       
                   
       
  

or

       
       
       while (snl.hasNext()) {
            SubjectNode[] nodes = snl.getNextSubjectNodes(snl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextSubjectNode

SubjectNode getNextSubjectNode()
                               throws OperationFailedException

Gets the next SubjectNode in this list.

Returns:

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

getNextSubjectNodes

SubjectNode[] getNextSubjectNodes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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