j3.mssql
Class SpParmSQL

java.lang.Object
  |
  +--j3.mssql.SpParmSQL

public class SpParmSQL

extends java.lang.Object

JDBC database access class
Procedure Name : spParm
Catalog : J3Demo
Schema : dbo
All JDBC calls to the procedure are in this class
Generated by JDatabase Wizard build 1466, 24-Oct-02 16:53:49

Field Summary

private java.sql.CallableStatement	myCall Class wide CallableStatement used to extract data
protected java.lang.String	myEmailIn stored procedure parameter EmailIn
protected java.lang.String	myEmailOut stored procedure parameter EmailOut
protected java.lang.String	myFirstName stored procedure parameter FirstName
protected java.lang.String	myLastName stored procedure parameter LastName
protected java.lang.Integer	myReturnValue stored procedure return value

Constructor Summary

SpParmSQL()

Method Summary

void	callSpParmSQL(java.sql.Connection theConnection) Call this method to execute the stored procedure
void	clearProperties() Sets this object's properties to null
void	close() Close any open ResultSets and Statements
void	closeCall() Closes the myCall member
protected void	finalize() close open statement and resultset
private java.lang.Integer	getCallInteger(java.sql.CallableStatement theCallableStatement, int theIndex) Utility function used to get the procedure's parameter or return value as a Integer
java.lang.String	getEmailIn() Retrieve the stored procedure parameter EmailIn
java.lang.String	getEmailOut() Retrieve the stored procedure parameter EmailOut
java.lang.String	getFirstName() Retrieve the stored procedure parameter FirstName
java.lang.String	getLastName() Retrieve the stored procedure parameter LastName
java.lang.Integer	getReturnValue() Retrieve the stored procedure return value
void	postCall() This is called when all resultset rows have been retrieved This method retrieves the stored procedure's return value and any INOUT / OUT parameter values
void	setEmailIn(java.lang.String theEmailIn) set the stored procedure parameter EmailIn
void	setEmailOut(java.lang.String theEmailOut) set the stored procedure parameter EmailOut
void	setFirstName(java.lang.String theFirstName) set the stored procedure parameter FirstName
void	setLastName(java.lang.String theLastName) set the stored procedure parameter LastName
void	setReturnValue(java.lang.Integer theReturnValue) set the stored procedure return value here for completeness

Methods inherited from class java.lang.Object

, clone, equals, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

myCall

private java.sql.CallableStatement myCall

Class wide CallableStatement used to extract data

myEmailIn

protected java.lang.String myEmailIn

stored procedure parameter EmailIn

myEmailOut

protected java.lang.String myEmailOut

stored procedure parameter EmailOut

myFirstName

protected java.lang.String myFirstName

stored procedure parameter FirstName

myLastName

protected java.lang.String myLastName

stored procedure parameter LastName

myReturnValue

protected java.lang.Integer myReturnValue

stored procedure return value

Constructor Detail

SpParmSQL

public SpParmSQL()

Method Detail

callSpParmSQL

public void callSpParmSQL(java.sql.Connection theConnection)
                   throws java.sql.SQLException

Call this method to execute the stored procedure

Parameters:

theConnection - The OPEN JDBC connection to use

Throws:

java.sql.SQLException - An unexpected JDBC event occurred

clearProperties

public void clearProperties()

Sets this object's properties to null

close

public void close()

Close any open ResultSets and Statements

closeCall

public void closeCall()
               throws java.sql.SQLException

Closes the myCall member

Throws:

java.sql.SQLException - An unexpected JDBC event occurred

finalize

protected void finalize()
                 throws java.lang.Throwable

close open statement and resultset

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - superclass could throw this

getCallInteger

private java.lang.Integer getCallInteger(java.sql.CallableStatement theCallableStatement,
                                         int theIndex)
                                  throws java.sql.SQLException

Utility function used to get the procedure's parameter or return value as a Integer

Parameters:

theCallableStatement - Used to get the procedure parameters and return value

theIndex - The parameter index to get

Returns:

The procedure parameter or return value as an Integer

Throws:

java.sql.SQLException - An unexpected JDBC event occurred

getEmailIn

public java.lang.String getEmailIn()

Retrieve the stored procedure parameter EmailIn

Returns:

The property @EmailIn

getEmailOut

public java.lang.String getEmailOut()

Retrieve the stored procedure parameter EmailOut

Returns:

The property @EmailOut

getFirstName

public java.lang.String getFirstName()

Retrieve the stored procedure parameter FirstName

Returns:

The property @FirstName

getLastName

public java.lang.String getLastName()

Retrieve the stored procedure parameter LastName

Returns:

The property @LastName

getReturnValue

public java.lang.Integer getReturnValue()

Retrieve the stored procedure return value

Returns:

The property @RETURN_VALUE

postCall

public void postCall()
              throws java.sql.SQLException

This is called when all resultset rows have been retrieved
This method retrieves the stored procedure's return value and any INOUT / OUT parameter values

Throws:

java.sql.SQLException - An unexpected JDBC event occurred

setEmailIn

public void setEmailIn(java.lang.String theEmailIn)

set the stored procedure parameter EmailIn

Parameters:

theEmailIn - Value to assign to the property @EmailIn

setEmailOut

public void setEmailOut(java.lang.String theEmailOut)

set the stored procedure parameter EmailOut

Parameters:

theEmailOut - Value to assign to the property @EmailOut

setFirstName

public void setFirstName(java.lang.String theFirstName)

set the stored procedure parameter FirstName

Parameters:

theFirstName - Value to assign to the property @FirstName

setLastName

public void setLastName(java.lang.String theLastName)

set the stored procedure parameter LastName

Parameters:

theLastName - Value to assign to the property @LastName

setReturnValue

public void setReturnValue(java.lang.Integer theReturnValue)

set the stored procedure return value here for completeness

Parameters:

theReturnValue - Value to assign to the property @RETURN_VALUE