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()); }
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. |
UpdateResponse getNextUpdateResponse() throws OperationFailedException
UpdateResponse
in this list. UpdateResponse
in this list. The
hasNext()
method should be used to test that a
next UpdateResponse
is available before calling
this method.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented. UpdateResponse[] getNextUpdateResponses(long n) throws OperationFailedException
UpdateResponses
in this list. The
specified amount must be less than or equal to the return from
available().
n
- the number of UpdateResponse
elements
requested which must be less than or equal to
available()
UpdateResponse
elements.
The length of the array is less than or equal to the
number specified.IllegalStateException
- no more elements available in
this listOperationFailedException
- unable to complete requestmandatory
- This method must be implemented.