Stored procedure context. More...

Inheritance diagram for ProcedureContext:

[legend]

Collaboration diagram for ProcedureContext:

[legend]

Public Member Functions
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	AddContext (_.Library.IProcedureContext pContext, _.Library.Boolean propagateerror)
	AddContext() is for nesting procedure context objects. More...

	AddPrivateTable (_.XSQL.DS.TempTable pTable)
	AddPrivateTable() More...

	AddResultSet (_.Library.IResultSet rs)
	AddResultSet() - add a new result object to the context object. More...

_.Library.Status	CloseCurrentResult ()
	Close the current resultset object, used to allow the cleanup code to run and the cursor to close.

	DumpResults (_.Library.String pDelimiter)
	DumpResults() More...

_.Library.RegisteredObject	NextResult ()
	Called to return the next resultset object. More...

	RemovePrivateTable (_.Library.String pTableName)
	RemovePrivateTable() will remove the private table name from the current context object or the process context. More...

_.Library.String	ResolveTableName (_.Library.String pTableName, _.Library.ProcedureContext pContext, _.Library.Integer pDDLFlag)
	ResolveTableName will locate a temporary table registered in either the current object (usually equates to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	static
	More...

Public Attributes inherited from IProcedureContext
	Error
	More...

Private Member Functions
_.Library.RegisteredObject	NextResult ()
	Stored procedure context. More...

Private Attributes
	__context
	More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

Stored procedure context.

Member Function Documentation

◆ NextResult() [1/2]

_.Library.RegisteredObject NextResult ( )

private

Stored procedure context.

Called to return the next resultset object.

This also removes the reference to the existing object so it can cleanup and close itself

Reimplemented from IProcedureContext.

◆ OnClose()

_.Library.Status OnClose ( )

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from RegisteredObject.

◆ AddContext()

_.Library.Status AddContext	(	_.Library.IProcedureContext	pContext,
		_.Library.Boolean	propagateerror
	)

AddContext() is for nesting procedure context objects.

If one procedure invokes another procedure and the results

of calling the nested procedure are to be returned to the caller of the outer procedure then simply invoke AddContext on the context object of the outer procedure, passing the context object of the inner procedure as an argument, pContext. If the propagateerror argument is true then any error encountered by the nested procedure will be reported as an error to the caller of the outer procedure.

◆ AddPrivateTable()

AddPrivateTable ( _.XSQL.DS.TempTable pTable )

AddPrivateTable()

   This method will register a temporary table object. Only registered table objects are usable by dSQL.
   The TTNI property is the <source_language_tablename> to <actual_tablename> index and is not set up here
   since the actual table (referenced by pTable) has no clue as to the source language table name. That must
   be done by the source language.

◆ AddResultSet()

AddResultSet ( _.Library.IResultSet rs )

AddResultSet() - add a new result object to the context object.

Results are

accessible by callers of the procedure through the NextResult/CurrentResult interface.

◆ DumpResults()

DumpResults ( _.Library.String pDelimiter )

DumpResults()

This method writes all of the results to the current device. The pDelimiter parameter is passed to the result set's Print() method.

◆ NextResult() [2/2]

_.Library.RegisteredObject NextResult ( )

Called to return the next resultset object.

This also removes the reference to the existing object so it can cleanup and close itself

Reimplemented from IProcedureContext.

◆ RemovePrivateTable()

RemovePrivateTable ( _.Library.String pTableName )

RemovePrivateTable() will remove the private table name from the current context object or the process context.

object. The storage offset information remains to that any existing result sets will still be valid. However, If another instance of a private table with the same name is created any result sets against the prior private table may become invalid.

◆ ResolveTableName()

_.Library.String ResolveTableName	(	_.Library.String	pTableName,
		_.Library.ProcedureContext	pContext,
		_.Library.Integer	pDDLFlag
	)

ResolveTableName will locate a temporary table registered in either the current object (usually equates to.

sqlcontext) or in the process context object (processcontext). The temporary table name passed into this method is the host language name such as #my_temp in TSQL or a normal temporary table name in Informix. This name is the one bound to the actual name in the TTNI (temporary table name index) by the host language procedure. If the table name is not found in TTNI, either local(current object) or global (processcontext) then the name submitted is returned an no context is returned in the byref pContext argument.

Member Data Documentation

◆ __context

__context

private

◆ static

static

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members