Interface InquestNodeList

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

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

while (inl.hasNext()) {
     InquestNode node = inl.getNextInquestNode();
}
or 
while (inl.hasNext()) {
     InquestNode[] nodes = inl.getNextInquestNodes(inl.available());
}

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

  • Method Details

    • getNextInquestNode

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

    • getNextInquestNodes

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