org.osid.profile

Interface ProfileNodeList

All Superinterfaces:

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

public interface ProfileNodeList
extends OsidList

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

       
       
       while (pnl.hasNext()) {
            ProfileNode node = pnl.getNextProfileNode();
       }
       
                   
       
  

or

       
       
       while (pnl.hasNext()) {
            ProfileNode[] nodes = pnl.getNextProfileNodes(pnl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
ProfileNode	getNextProfileNode() Gets the next ProfileNode in this list.
ProfileNode[]	getNextProfileNodes(long n) Gets the next set of ProfileNode elements in this list which must be less than or equal to the return 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

getNextProfileNode

ProfileNode getNextProfileNode()
                               throws OperationFailedException

Gets the next ProfileNode in this list.

Returns:

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

getNextProfileNodes

ProfileNode[] getNextProfileNodes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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