CarobNS::RequestWithResultSetParameters Class Reference

This class defines a Request with additional parameters indicating how the ResulSet should be fetched. More...

#include <RequestWithResultSetParameters.hpp>

Inheritance diagram for CarobNS::RequestWithResultSetParameters:

CarobNS::Request List of all members.

Public Member Functions

void sendToStream (const DriverSocket &out) const throw (SocketIOException, UnexpectedException)
 Also serialize ResultSet parameters to the stream.
bool isCursorNameNull () const
 Returns the cursorNameIsNull value.
std::wstring getCursorName () const
 Returns the cursorName value.
void setCursorName (std::wstring cursorNamePrm)
 Sets the cursorName value.
int getFetchSize () const
 Returns the fetchSize value.
void setFetchSize (int fetchSizePrm)
 Sets the fetchSize value.
int getMaxRows () const
 Returns the maxRows value.
void setMaxRows (int maxRowsPrm)
 Sets the maxRows value.

Protected Member Functions

 RequestWithResultSetParameters (std::wstring sql)
 Creates a new RequestWithResultSetParameters object.

Friends

class Statement
class ParameterStatement

Detailed Description

This class defines a Request with additional parameters indicating how the ResulSet should be fetched.

This is only useful for calls to Statement.executeQuery() or Statement.execute() when ResultSets are returned.


Constructor & Destructor Documentation

CarobNS::RequestWithResultSetParameters::RequestWithResultSetParameters ( std::wstring  sql  )  [protected]

Creates a new RequestWithResultSetParameters object.

Protected to ensure no one but friend classes can use us

Parameters:
sql the SQL statement


Member Function Documentation

void CarobNS::RequestWithResultSetParameters::sendToStream ( const DriverSocket out  )  const throw (SocketIOException, UnexpectedException)

Also serialize ResultSet parameters to the stream.

Optionally used by serializers of those derived requests that expect a ResultSet.

Parameters:
out destination socket to controller
Exceptions:
SocketIOException an error occurs on the stream
See also:
Request::sendToStream(const DriverSocket&) const

Reimplemented from CarobNS::Request.

bool CarobNS::RequestWithResultSetParameters::isCursorNameNull (  )  const [inline]

Returns the cursorNameIsNull value.

Returns:
true if the cursorName is NULL (not valid)

std::wstring CarobNS::RequestWithResultSetParameters::getCursorName (  )  const [inline]

Returns the cursorName value.

Returns:
Returns the cursorName.

void CarobNS::RequestWithResultSetParameters::setCursorName ( std::wstring  cursorNamePrm  )  [inline]

Sets the cursorName value.

Parameters:
cursorNamePrm cursorName to set.

int CarobNS::RequestWithResultSetParameters::getFetchSize (  )  const [inline]

Returns the fetchSize value.

Returns:
Returns the fetchSize.

void CarobNS::RequestWithResultSetParameters::setFetchSize ( int  fetchSizePrm  )  [inline]

Sets the fetchSize value.

Parameters:
fetchSizePrm fetchSize to set.

int CarobNS::RequestWithResultSetParameters::getMaxRows (  )  const [inline]

Returns the maxRows value.

Returns:
maximum number of rows.

void CarobNS::RequestWithResultSetParameters::setMaxRows ( int  maxRowsPrm  )  [inline]

Sets the maxRows value.

Parameters:
maxRowsPrm maxRows to set.


The documentation for this class was generated from the following file:
Generated on Tue Oct 24 09:05:38 2006 for Carob by  doxygen 1.5.0