Interface CreateResponseList

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

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

while (crl.hasNext()) {
     CreateResponse response = crl.getNextCreateResponse();
}
or 
while (crl.hasNext()) {
     CreateResponse[] responses = crl.getNextCreateResponses(crl.available());
}

  • Method Summary

    Modifier and Type
    Method
    Description
    CreateResponse
    getNextCreateResponse()
    Gets the next CreateResponse in this list.
    CreateResponse[]
    getNextCreateResponses(long n)
    Gets the next set of CreateResponses in this list.

    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

    • getNextCreateResponse

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

    • getNextCreateResponses

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