org.osid.transaction.batch

Interface UpdateResponseList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface UpdateResponseList
extends OsidList

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

       
       
       while (url.hasNext()) {
            UpdateResponse response = url.getNextUpdateResponse();
       }
       
                   
       
  

or

       
       
       while (url.hasNext()) {
            UpdateResponse[] responses = url.getNextUpdateResponses(url.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
UpdateResponse	getNextUpdateResponse() Gets the next UpdateResponse in this list.
UpdateResponse[]	getNextUpdateResponses(long n) Gets the next set of UpdateResponses in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextUpdateResponse

UpdateResponse getNextUpdateResponse()
                                     throws OperationFailedException

Gets the next UpdateResponse in this list.

Returns:

the next UpdateResponse in this list. The hasNext() method should be used to test that a next UpdateResponse 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.

getNextUpdateResponses

UpdateResponse[] getNextUpdateResponses(long n)
                                        throws OperationFailedException

Gets the next set of UpdateResponses in this list. The specified amount must be less than or equal to the return from available().

Parameters:

n - the number of UpdateResponse elements requested which must be less than or equal to available()

Returns:

an array of UpdateResponse 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.