Interface CommitmentPeerList

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

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

while (cpl.hasNext()) {
     CommitmentPeer peer = cpl.getNextCommitmentPeer();
}
or 
while (cpl.hasNext()) {
     CommitmentPeer[] peers = cpl.getNextCommitmentPeers(cpl.available());
}

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

  • Method Details

    • getNextCommitmentPeer

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

    • getNextCommitmentPeers

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