Interface ResponseList

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

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

while (rl.hasNext()) {
     Response response = rl.getNextResponse();
}
or 
while (rl.hasNext()) {
     Response[] responses = rl.getNextResponses(rl.available());
}

  • Method Summary

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

    • getNextResponse

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

    • getNextResponses

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