Interface RepositoryNodeList

All Superinterfaces:
AutoCloseable, Closeable, OsidList, OsidList
public interface RepositoryNodeList extends OsidList

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

while (rnl.hasNext()) {
     RepositoryNode node = rnl.getNextRepositoryNode();
}
or 
while (rnl.hasNext()) {
     RepositoryNode[] nodes = rnl.getNextRepositoryNodes(rnl.available());
}

Like all OsidLists, RepositoryNodeList is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getNextRepositoryNode

      RepositoryNode getNextRepositoryNode() throws OperationFailedException
      Gets the next RepositoryNode in this list.
      Returns:
      the next RepositoryNode in this list. The hasNext() method should be used to test that a next RepositoryNode 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.

    • getNextRepositoryNodes

      RepositoryNode[] getNextRepositoryNodes(long n) throws OperationFailedException
      Gets the next set of RepositoryNode elements in this list which must be less than or equal to the return from available().
      Parameters:
      n - the number of RepositoryNode elements requested which must be less than or equal to available()
      Returns:
      an array of RepositoryNode 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.