org.josef.jdbc

Class StoredProcedureParameter

java.lang.Object

org.josef.jdbc.StoredProcedureParameter

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Reviews(value=@Review(by="Kees Schotanus",at="2009-04-13"))
public class StoredProcedureParameter
extends Object

Abstraction of a SQL parameter that is used in a stored procedure.

Version:

1.0 $Revision: 5136 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
StoredProcedureParameter(String name, CType jdbcType) Constructs this StoredProcedureParameter with a type of OUT.
StoredProcedureParameter(String name, CType jdbcType, Object value) Constructs this StoredProcedureParameter with a type of IN.
StoredProcedureParameter(String name, StoredProcedureParameterType storedProcedureParameterType, CType jdbcType, Object value) Constructs this StoredProcdureParameter.

Method Summary

Modifier and Type	Method and Description
CType	getJdbcType() Gets the JDBC type of this parameter.
String	getName() Gets the name of this parameter.
StoredProcedureParameterType	getSqlParameterType() Gets the type of this parameter.
Object	getValue() Gets the value of this parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoredProcedureParameter

public StoredProcedureParameter(String name,
                                CType jdbcType)

Constructs this StoredProcedureParameter with a type of OUT.

Parameters:

name - Name of this parameter.

jdbcType - The JDBC type of this parameter.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When either the supplied name or jdbcType is null.

StoredProcedureParameter

public StoredProcedureParameter(String name,
                                CType jdbcType,
                                Object value)

Constructs this StoredProcedureParameter with a type of IN.

Parameters:

name - Name of this parameter.

jdbcType - The JDBC type of this parameter.

value - The value of this parameter.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When either the supplied name or jdbcType is null.

StoredProcedureParameter

public StoredProcedureParameter(String name,
                                StoredProcedureParameterType storedProcedureParameterType,
                                CType jdbcType,
                                Object value)

Constructs this StoredProcdureParameter.

Parameters:

name - Name of this parameter.

storedProcedureParameterType - The type of this SQL parameter.

jdbcType - The JDBC type of this parameter.

value - The value of this parameter.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When either the supplied name or jdbcType is null.

Method Detail

getName

public String getName()

Gets the name of this parameter.

Returns:

The name of this parameter.

getSqlParameterType

public StoredProcedureParameterType getSqlParameterType()

Gets the type of this parameter.

Returns:

The type of this parameter.

getJdbcType

public CType getJdbcType()

Gets the JDBC type of this parameter.

Returns:

The JDBC type of this parameter.

getValue

public Object getValue()

Gets the value of this parameter.

Returns:

The value of this parameter.
For an OUT parameter null is returned.