org.osid.personnel

Interface OrganizationNodeList

All Superinterfaces:

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

public interface OrganizationNodeList
extends OsidList

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

       
       
       while (onl.hasNext()) {
            OrganizationNode node = onl.getNextOrganizationNode();
       }
       
                   
       
  

or

       
       
       while (onl.hasNext()) {
            OrganizationNode[] nodes = onl.getNextOrganizationNodes(onl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextOrganizationNode

OrganizationNode getNextOrganizationNode()
                                         throws OperationFailedException

Gets the next OrganizationNode in this list.

Returns:

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

getNextOrganizationNodes

OrganizationNode[] getNextOrganizationNodes(long n)
                                            throws OperationFailedException

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

Parameters:

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

Returns:

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