Interface RequestTransactionPeerList

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

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

while (rtpl.hasNext()) {
     RequestTransactionPeer peer = rtpl.getNextRequestTransactionPeer();
}
or 
while (rtpl.hasNext()) {
     RequestTransactionPeer[] peers = rtpl.getNextRequestTransactionPeers(rtpl.available());
}

  • Method Details

    • getNextRequestTransactionPeer

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

    • getNextRequestTransactionPeers

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