Reads from the archive for the current cursor position.
<readArchiveRequest> <filter type="Filter"/> <cursor type="int"/> <count type="int"/> </readArchiveRequest>
<readArchiveResponse> <cursor type="int"/> <items type="ItemList"/> <status type="Status"/> </readArchiveResponse>
Specifies the number of items to be read. The cursor is then repositioned by the number in the count element.
On the first call, the cursor is 0. This indicates a new read (cursor) on the archive server. The archive server returns a value for the cursor in the ReadArchiveResponse. That value is passed in the next readArchiveRequest call. The POA continues to call readArchiveRequest until the archive server passes back 0 for the cursor element in readArchiveResponse. That signals there is no more data.
Specifies the filter.
Returns the success or failure of the method.
The readArchiveRequest works like the cursor calls in the standard SOAP documentation, but the readArchiveRequest handles the createCursorRequest and readCursorRequest functionality in one call. The archive usually signals the end of data by passing 0 back in the cursor element of the readArchiveResponse.
Because of this, there is no need to do a destroyCursorRequest call as in the standard SOAP API. It is possible for the POA to cancel the reading of data. To do so, the POA passes the cursor value in the cancelReadRequest. This signals the archive server that the read is done and the archive server can free any resources involved in the read.