Interface SubtaskIssuePeerList

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

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

while (sipl.hasNext()) {
     SubtaskIssuePeer peer = sipl.getNextSubtaskissuePeer();
}
or 
while (sipl.hasNext()) {
     SubtaskIssuePeer[] peers = sipl.getNextSubtaskIssuePeers(ispl.available());
}

  • Method Details

    • getNextSubtaskIssuePeer

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

    • getNextSubtaskIssuePeers

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