com.baan.ow.xmlconnector
Interface IXMLCIterator

public interface IXMLCIterator

This class provides an Iterator functionality, with the help of which the user can decide the number of records to fetch.

Since:

classVersion 2.4

Version:

Build Nr 61, file version \\main\\Middleware-3_11\\1, 15:35:59 24-07-2006 UTC

Author:

Baan Company

Method Summary

boolean	hasMoreRecords() Indicates whether there are more records to return.
boolean	nextSetOfRecords(java.lang.StringBuffer p_responseDoc, java.lang.StringBuffer p_requestStatus) This method will return the next set of records from the set of records that is being iterated through.
void	setRecordSize(int p_recordSize) Sets the number of records that should be returned in each fetch.

Method Detail

hasMoreRecords

public boolean hasMoreRecords()
                       throws com.baan.b3.boi1.BoiException,
                              com.baan.b3.boi1.BoiApplicationException

Indicates whether there are more records to return.

Returns:

boolean
true if there are more records to return else returns false.

Throws:

throws: - com.baan.b3.boi1.BoiException - if an adapter or transport level error occurred com.baan.b3.boi1.BoiApplicationException - if the query resulted in an error in the backend

com.baan.b3.boi1.BoiException

com.baan.b3.boi1.BoiApplicationException

Since:

classVersion 2.4

nextSetOfRecords

public boolean nextSetOfRecords(java.lang.StringBuffer p_responseDoc,
                                java.lang.StringBuffer p_requestStatus)

This method will return the next set of records from the set of records that is being iterated through.

Parameters:

p_responseDoc - When the call is successful, this referance variable will contain the fetched records in XML format.

p_requestStatus - In case for some reason the records could not be fetched, the p_requestStatus, contains will contain the requesStatus document.

Returns:

boolean
Returns true if the next set of records are successfully fetched, else returns false.

Since:

classVersion 2.4

setRecordSize

public void setRecordSize(int p_recordSize)

Sets the number of records that should be returned in each fetch. The IXMLCIterator retrieves all it's data in sets in XML format, and the size of these sets is configurable. If this is not set by the user at runtime, then XML Connector will use the 'Iterator size' as set in the adapter configuration. In such a scenario if the adapter iterator size set is '0', then XML Connector will return all the data retrieved from the backend in XML format.

Note that retrieving the data in sets is done for reducing the memory consumption on the client side, due to the records returned in user defined sets. The optimal recordSize depends on the memory available on the client side to hold one record (and number of sub records), the transport speed, and the time the OpenWorldX Adapter backend needs to produce the data.

Parameters:

p_recordSize - The number of records that should be returned in XML format in each fetch.

Since:

classVersion 2.4