org.osid.workflow

Interface OfficeNodeList

All Superinterfaces:

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

public interface OfficeNodeList
extends OsidList

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

       
       
       while (onl.hasNext()) {
            OfficeNode node = onl.getNextOfficeNode();
       }
       
                   
       
  

or

       
       
       while (onl.hasNext()) {
            OfficeNode[] nodes = onl.getNextOfficeNodes(onl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOfficeNode

OfficeNode getNextOfficeNode()
                             throws OperationFailedException

Gets the next OfficeNode in this list.

Returns:

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

getNextOfficeNodes

OfficeNode[] getNextOfficeNodes(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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