Twin class for IldRequest, with inheritance capability. More...

#include <ildblink/reqmodl.h>

Inheritance diagram for IldRequestModel:

Public Member Functions
	IldRequestModel (IldDbmsModel *)
	Allocates a new `IldRequestModel` instance attached to the given connection.

virtual IldRequest &	bindCol (IlUShort i, IldColumnType t, IlAny buf, IlUInt size=0, short *inds=0)
	As `IldRequest::bindCol(IlUShort, IldColumnType, IlAny, IlUInt, short*)`.

virtual IldRequest &	bindCol (const char name, IldColumnType t, IlAny buff, IlUInt size=0, short inds=0)
	As `IldRequest::bindCol(const char, IldColumnType, IlAny, IlUInt, short)`.

virtual IldRequest &	bindParam (IlUShort i, IldColumnType t, IlInt s=-1, IlAny buff=0, short inds=0, IlBoolean out=IlFalse, IlUShort aSize=0, IldADTDescriptor adt=0)
	As `IldRequest::bindParam(IlUShort, IldColumnType, IlInt, IlAny, short, IlBoolean, IlUShort, IldADTDescriptor)`.

virtual IldRequest &	bindParam (const char name, IldColumnType t, IlInt s=-1, IlAny buff=0, short inds=0, IlBoolean out=IlFalse, IlUShort aSize=0, IldADTDescriptor *adt=0)
	As `IldRequest::bindParam(const char, IldColumnType, IlInt, IlAny, short, IlBoolean, IlUShort, IldADTDescriptor*)`.

virtual IldRequest &	closeCursor ()
	As `IldRequest::closeCursor()`.

virtual IldRequest &	execute (IlInt *rowCount=0, IlInt count=-1)
	As `IldRequest::execute(IlInt*, IlInt)`.

virtual IldRequest &	execute (const char query, IlInt rowCount=0)
	As `IldRequest::execute(const char, IlInt)`.

virtual IldRequest &	fetch ()
	As `IldRequest::fetch()`.

virtual IldRequest &	fetchScroll (IlInt orient=IldFetchDirectionNext, IlInt offset=0)
	As `IldRequest::fetchScroll()`.

virtual IldADTValue *	getColADTValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColADTValue(IlUShort, IlUInt)`.

virtual IlUInt	getColArraySize () const
	As `IldRequest::getColArraySize()`.

virtual IldBytes	getColBinaryValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColBinaryValue(IlUShort, IlUInt)`.

virtual IlUChar	getColByteValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColByteValue(IlUShort, IlUInt)`.

virtual IlUShort	getColCount () const
	As `IldRequest::getColCount()`.

virtual IldDateTime	getColDateTimeValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColDateTimeValue(IlUShort, IlUInt)`.

virtual IldDateTime	getColDateTimeValue (const unsigned char *)
	As `IldRequest::getColDateTimeValue(const unsigned char*)`.

virtual const char *	getColDateValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColDateValue(IlUShort, IlUInt)`.

virtual IldAppDescriptor *	getColDescriptor (IlUShort c)
	As `IldRequest::getColDescriptor()`.

virtual short	getColIndex (const char *name)
	As `IldRequest::getColIndex(const char*)`.

virtual IlInt	getColIntegerValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColIntegerValue(IlUShort, IlUInt)`.

virtual const char *	getColLongTextValue (IlUShort c, IlUInt r=0, IlInt *s=0)
	As `IldRequest::getColLongTextValue(IlUShort, IlUInt, IlInt*)`.

virtual double	getColMoneyValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColMoneyValue(IlUShort, IlUInt)`.

virtual const char *	getColName (IlUShort i)
	As `IldRequest::getColName(IlUShort)`.

virtual IlNumeric	getColNumericValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColNumericValue(IlUShort, IlUInt)`.

virtual double	getColRealValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColRealValue(IlUShort, IlUInt)`.

virtual IldBytes	getColRefValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColRefValue(IlUShort, IlUInt)`.

virtual const char *	getColRTrimedStringValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColRTrimedStringValue(IlUShort, IlUInt)`.

virtual IlUInt	getColSize (IlUShort i) const
	As `IldRequest::getColSize(IlUShort)`.

virtual short	getColSQLType (IlUShort i) const
	As `IldRequest::getColSQLType(IlUShort)`.

virtual const char *	getColSQLTypeName (IlUShort i) const
	As `IldRequest::getColSQLTypeName(IlUShort)`.

virtual const char *	getColStringValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getColStringValue(IlUShort, IlUInt)`.

virtual IldColumnType	getColType (IlUShort i) const
	As `IldRequest::getColType(IlUShort)`.

virtual const char *	getCursorName () const
	As `IldRequest::getCursorName()`.

virtual IldDbms &	getDbms () const
	As `IldRequest::getDbms()`.

virtual IldErrorReporter *	getErrorReporter () const
	As `IldRequest::getErrorReporter()`.

virtual IlAny	getHook () const
	`As IldRequest::getHook()`.

virtual IldRequest &	getLargeObject (const char table, const char column, const char where, const char file)
	As `IldRequest::getLargeObject(const char, const char. const char, const char)`.

virtual IldRequest &	getLargeObjectChunk (IlUInt size, IlUChar data, IlUInt offset)
	As `IldRequest::getLargeObjectChunk(IlUInt, IlUChar, IlUInt)`.

virtual IldADTValue *	getParamADTValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamADTValue(IlUShort, IlUInt)`.

virtual IlUInt	getParamArraySize () const
	As `IldRequest::getParamArraySize()`.

virtual IldBytes	getParamBinaryValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamBinaryValue(IlUShort, IlUInt)`.

virtual IlUInt	getParamBufferSize (IlUShort i) const
	As `IldRequest::getParamBufferSize(IlUShort)`.

virtual IlUChar	getParamByteValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamByteValue(IlUShort, IlUInt)`.

virtual IlUShort	getParamCount () const
	As `IldRequest::getParamCount()`.

virtual IldRequest *	getParamCursorValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamCursorValue(IlUShort, IlUInt)`.

virtual IldDateTime	getParamDateTimeValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamDateTimeValue(IlUShort, IlUInt)`.

virtual const char *	getParamDateValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamDateValue(IlUShort, IlUInt)`.

virtual IldAppDescriptor *	getParamDescriptor (IlUShort i)
	As `IldRequest::getParamDescriptor(IlUShort)`.

virtual short	getParamIndex (const char *name)
	As `IldRequest::getParamIndex(const char*)`.

virtual IlInt	getParamIntegerValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamIntegerValue(IlUShort, IlUInt)`.

virtual const char *	getParamLongTextValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamLongTexTValue(IlUShort, IlUInt)`.

virtual double	getParamMoneyValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamMoneyValue(IlUShort, IlUInt)`.

virtual const char *	getParamName (IlUShort i)
	As `IldRequest::getParamName(IlUShort)`.

virtual IlNumeric	getParamNumericValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamNumericValue(IlUShort, IlUInt)`.

virtual double	getParamRealValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamRealValue(IlUShort, IlUInt)`.

virtual IldBytes	getParamRefValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamRefValue(IlUShort, IlUInt)`.

virtual IlUInt	getParamSize (IlUShort i) const
	As `IldRequest::getParamSize(IlUShort)`.

virtual short	getParamSQLType (IlUShort i) const
	As `IldRequest::getParamSQLType(IlUShort)`.

virtual const char *	getParamSQLTypeName (IlUShort i) const
	As `IldRequest::getParamSQLTypeName(IlUShort)`.

virtual const char *	getParamStringValue (IlUShort c, IlUInt r=0)
	As `IldRequest::getParamStringValue(IlUShort, IlUInt)`.

virtual IldColumnType	getParamType (IlUShort i) const
	As `IldRequest::getParamType(IlUShort)`.

virtual IlUInt	getRowPos () const
	As `IldRequest::getRowPos()`.

virtual IlUInt	getRowProcessedCount () const
	As `IldRequest::getRowProcessedCount()`.

virtual IlInt	getStatus () const
	As `IldRequest::getStatus()`.

virtual IlBoolean	hasTuple () const
	As `IldRequest::hasTuple()`.

virtual IldRequest &	insertBinary (IldBytes &data, const char table, const char column, const char *where=0)
	As `IldRequest::insertBinary(IldBytes&, const char, const char, const char*)`.

virtual IldRequest &	insertLongText (const char text, IlUInt size, const char table, const char column, const char where=0)
	As `IldRequest::insertLongText(const char, IlUInt, const char, const char, const char)`.

virtual IlBoolean	isColNull (IlUShort c, IlUInt r=0)
	As `IldRequest::isColNull(IlUShort, IlUInt)`.

virtual IlBoolean	isCompleted () const
	As `IldRequest::isCompleted()`.

virtual IlBoolean	isCursorModeOn () const
	As `IldRequest::isCursorModeOn()`.

virtual IlBoolean	isNullIndicatorOn (short *buff, IlUInt r=0) const
	As `IldRequest::isNullIndicatorOn(IlAny, IlUInt = 0)`.

virtual IlBoolean	isParamNull (IlUShort c, IlUInt r=0)
	As `IldRequest::isParamNull(IlUShort, IlUInt)`.

virtual IlBoolean	isReadOnly () const
	As `IldRequest::isReadOnly()`.

virtual IlBoolean	isScrollable () const
	As `IldRequest::isScrollable()`.

virtual IldRequest &	parse (const char *query)
	As `IldRequest::parse(const char*)`.

virtual IldRequest &	removeColArraySize ()
	As `IldRequest::removeColArraySize()`.

virtual IldRequest &	removeParamArraySize ()
	As `IldRequest::removeParamArraySize()`.

virtual IldRequest &	setColArraySize (IlUInt size)
	As `IldRequest::setColArraySize(IlUInt)`.

virtual IldRequest &	setCursorModeOn (IlBoolean f=IlTrue)
	As `IldRequest::setCursorModeOn(IlBoolean)`.

virtual IldRequest &	setCursorName (const char *cName)
	As `IldRequest::setCursorName()`.

virtual IldRequest &	setErrorReporter (IldErrorReporter *rep)
	As `IldRequest::setErrorReporter()`.

virtual IldRequest &	setParamArraySize (IlUInt s)
	As `IldRequest::setParamArraySize(IlUInt)`.

virtual IldRequest &	setParamNullInd (IlUShort c, IlUInt r=0)
	As `IldRequest::setParamNullInd(IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (char v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(char, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (IlInt v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(IlInt, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (double v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(double, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (const char *v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(const char*, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (IldBytes &v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(IldBytes&, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (const IldDateTime *v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(const IldDateTime*, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (const IlNumeric *v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(const IlNumeric*, IlUShort, IlUInt)`.

virtual IldRequest &	setParamValue (const IldADTValue *v, IlUShort c, IlUInt r=0)
	As `IldRequest::setParamValue(const IldADTValue*, IlUShort, IlUInt)`.

virtual IldRequest &	setReadOnly (IlBoolean f=IlTrue)
	As `IldRequest::setReadOnly(IlBoolean)`.

virtual IldRequest &	setRowPos (IlUInt)
	As `IldRequest::setRowPos(IlUInt)`.

virtual IldRequest &	setScrollable (IlBoolean f=IlTrue)
	As `IldRequest::setScrollable(IlBoolean)`.

virtual IldRequest &	startGetLargeObject (const char table, const char column, const char *where)
	As `IldRequest::startGetLargeObject(const char, const char, * const char*)`.

Public Member Functions inherited from IldBaseModel
const IldDiagnostic *	getError () const
	As `IldIldBase::getError`.

IlInt	getErrorCode () const
	As `IldIldBase::getErrorCode`.

const char *	getErrorConnection () const
	As `IldIldBase::getErrorConnection`.

const char *	getErrorMessage () const
	As `IldIldBase::getErrorMessage`.

const char *	getErrorName () const
	As `IldIldBase::getErrorName`.

IldErrorOrigin	getErrorOrigin () const
	As `IldIldBase::getErrorOrigin`.

const char *	getErrorSqlstate () const
	As `IldIldBase::getErrorSqlState`.

const IldDiagnostic *	getInformation () const
	As `IldIldBase::getInformation`.

IlInt	getInformationCode () const
	As `IldIldBase::getInformationCode`.

const char *	getInformationMessage () const
	As `IldIldBase::getInformationMessage`.

IlBoolean	isErrorRaised () const
	As `IldIldBase::isErrorRaised`.

IlBoolean	isInformationRaised () const
	As `IldIldBase::isInformationRaised`.

int	operator! () const
	As `IldIldBase::operator!`.

void	setError (IldDiagnostic *)
	As `IldIldBase::setError`.

void	setInformation (IldDiagnostic *)
	As `IldIldBase::setInformation`.

virtual void	setNumericUse (IlBoolean flag)
	As `IldIldBase::setNumericUse`.

virtual void	setStringDateUse (IlBoolean flag=IlTrue)
	As `IldIldBase::setStringDateUse`.

virtual void	setStringNumericUse (IlBoolean flag=IlTrue)
	As `IldIldBase::setStringNumericUse`.

virtual IlBoolean	useNumeric () const
	As `IldIldBase::useNumeric`.

virtual IlBoolean	useStringDate () const
	As `IldIldBase::useStringDate`.

virtual IlBoolean	useStringNumeric () const
	As `IldIldBase::useStringNumeric`.

Public Member Functions inherited from IldIldBase
virtual	~IldIldBase ()
	Destructor for the base class of DB Link session and cursor classes. More...

void	clearDiagnostics ()
	Set diagnostic flags to false. More...

Public Member Functions inherited from IldRequest
virtual	~IldRequest ()
	This virtual destructor is invoked when an instance of `IldRequest` is destroyed. More...

Protected Member Functions
virtual IlBoolean	isFree ()
	Tell if the object is free to process statements. More...

virtual IldRequest &	release ()
	Free the invoking object. More...

Detailed Description

Twin class for IldRequest, with inheritance capability.

Library: dbkernel

Since the IldDbms and IldRequest classes cannot be inherited, new classes IldDbmsModel and IldRequestModel are provided. They offer the same functionalities as the IldDbms and IldRequest classes, and they can be inherited.

Therefore, the description of the various member functions is essentially the same as the description given in the IldRequest class. Differences are the following:

The constructor of the class must be used to instantiate an object of this class. The old allocation schema using IldDbms::getFreeRequest() is no longer available for the IldDbmsModel and IldRequestModel classes.
Since IldRequestModel instances are allocated using their constructor, the IldDbmsModel destructor cannot release all requests attached to it. As a consequence, the application must explicitly delete all unused requests.
Another consequence of this is that the release() function cannot be used for the IldRequestModel class.
And therefore, the isFree() function cannot be used for the IldRequestModel class.

Member Function Documentation

virtual IlBoolean IldRequestModel::isFree ( )

protectedvirtual

Tell if the object is free to process statements.

Returns: IlTrue if the invoking object is free to be used to process another statement or IlFalse if it is not the case.

Implements IldRequest.

virtual IldRequest& IldRequestModel::release ( )

protectedvirtual

Free the invoking object.

Returns: The current object by reference.

It processes the internal cleanup and calls the RDBMS API functions that are necessary to close any existing result set.

As a user, you should, in most situations, call this member function rather than the destructor of the class. However, because the current IldDbms object still references the newly released object (that is, the IldDbms object still holds a pointer to the IldRequest object), you must explicitly ask to reuse it.

This member function can raise the following errors:

Any error detected by the RDBMS itself.

Implements IldRequest.

Rogue Wave DBLink API Reference Guide

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation