Interface BankNodeList

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

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

while (bnl.hasNext()) {
     BankNode node = bnl.getNextBankNode();
}
or 
while (bnl.hasNext()) {
     BankNode[] nodes = bnl.getNextBankNodes(bnl.available());
}

  • Method Summary

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

    • getNextBankNode

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

    • getNextBankNodes

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