Interface ObjectiveBankNodeList

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

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

while (obnl.hasNext()) {
     ObjectiveBankNode node bank = obnl.getNextObjectiveBankNode();
}
or 
while (obnl.hasNext()) {
     ObjectiveBankNode[] nodes = obnl.getNextObjectiveBankNodes(obnl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    ObjectiveBankNode
    getNextObjectiveBankNode()
    Gets the next ObjectiveBankNode in this list.
    ObjectiveBankNode[]
    getNextObjectiveBankNodes(long n)
    Gets the next set of ObjectiveBankNode elements in this list which must be less than or equal to the return 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

    • getNextObjectiveBankNode

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

    • getNextObjectiveBankNodes

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