Interface OrganizationNodeList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, 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

    Modifier and Type
    Method
    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 Closeable

    close

    Methods inherited from interface OsidList

    close
    Modifier and Type
    Method
    Description
    void
    close()
    Close this list.

    Methods inherited from interface OsidList

    available, hasNext, skip
    Modifier and Type
    Method
    Description
    long
    available()
    Gets the number of elements available for retrieval.
    boolean
    hasNext()
    Tests if there are more elements in this list.
    void
    skip(long n)
    Skip the specified number of elements in the list.

  • Method Details

    • 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.