Interface OfferingPeerList

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

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

while (opl.hasNext()) {
     OfferingPeer peer = opl.getNextOfferingPeer();
}
or 
while (oopl.hasNext()) {
     OfferingPeer[] peers = opl.getNextOfferingPeers(opl.available());
}

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

  • Method Details

    • getNextOfferingPeer

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

    • getNextOfferingPeers

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