org.osid.process

Interface ProcessNodeList

All Superinterfaces:

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

public interface ProcessNodeList
extends OsidList

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

       
       
       while (pnl.hasNext()) {
            ProcessNode node = pnl.getNextProcessNode();
       }
       
                   
       
  

or

       
       
       while (pnl.hasNext()) {
            ProcessNode[] nodes = pnl.getNextProcessNodes(pnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextProcessNode

ProcessNode getNextProcessNode()
                               throws OperationFailedException

Gets the next ProcessNode in this list.

Returns:

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

getNextProcessNodes

ProcessNode[] getNextProcessNodes(long n)
                                  throws OperationFailedException

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

Parameters:

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

Returns:

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