public class SQLQueryParameter extends CloneableDataObject
Title: SQL Object Mediation: SQL Query Parameter
Description: Holds resolved sql query parameter
Copyright: Copyright (c) 2009
Company: StreamScape Technologies
DEFAULT_SERIAL_VERSION_ID
Constructor and Description |
---|
SQLQueryParameter() |
SQLQueryParameter(java.lang.String name,
int type,
java.lang.String typeName,
boolean nullable,
java.lang.String defaultValue,
java.lang.String value,
int length,
int precision,
int scale,
boolean searchable,
boolean returnCode,
int ordinal,
int mode)
Construts sql query parameter by passing all necessary information
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDefaultValue()
Returns parameter default value
|
int |
getLength()
Returns parameter type length
|
int |
getMode()
Returns parameter mode which can be id one of:
SQLQueryParameterMode.IN ,
SQLQueryParameterMode.OUT ,
SQLQueryParameterMode.INOUT , |
java.lang.String |
getName()
Returns parameter name
|
java.lang.Object |
getObjectValue() |
int |
getOrdinal()
Returns parameter ordinal in sql query
|
int |
getPrecision()
Returns parameter type precision
|
int |
getScale()
Returns parameter type scale
|
int |
getType()
Returns parameter type as id of
SQLTypeToken enumeration member |
java.lang.String |
getTypeName()
Returns parameter SQL type name
|
java.lang.String |
getValue()
Returns parameter value
|
boolean |
isNullable()
Returns whether parameter allows nulls
|
boolean |
isReturnCode()
Returns whether this parameter is used as return code of stored procedure call
|
boolean |
isSearchable()
Returns whether parameter is searchable i.e.
|
void |
setDefaultValue(java.lang.String defaultValue) |
void |
setDefaultValueWithoutValidation(java.lang.String defaultValue) |
void |
setObjectValue(java.lang.Object value) |
clone, getSerialVersionUID
public SQLQueryParameter()
public SQLQueryParameter(java.lang.String name, int type, java.lang.String typeName, boolean nullable, java.lang.String defaultValue, java.lang.String value, int length, int precision, int scale, boolean searchable, boolean returnCode, int ordinal, int mode) throws SQLQueryValidationException
name
- parameter nametype
- parameter typetypeName
- parameter SQL type namenullable
- whether paramater accepts nullsdefaultValue
- parameter default valuevalue
- parameter valuelength
- parameter type lengthprecision
- parameter type precisionscale
- parameter type scalesearchable
- wheteher parameter is searchablereturnCode
- whether parameter is return code of stored procedure callordinal
- parameter ordinal in sql querymode
- parameter modeSQLQueryValidationException
- if parameter type is not supported or parameter mode is unknownpublic java.lang.String getName()
public int getType()
SQLTypeToken
enumeration memberpublic java.lang.String getTypeName()
public java.lang.String getDefaultValue()
public void setDefaultValue(java.lang.String defaultValue) throws SQLQueryValidationException
SQLQueryValidationException
public void setDefaultValueWithoutValidation(java.lang.String defaultValue)
public java.lang.String getValue()
public boolean isSearchable()
WHERE
clauseTRUE
if parameter is searchablepublic int getLength()
public int getPrecision()
public int getScale()
public boolean isReturnCode()
TRUE
if parameter is return codepublic int getOrdinal()
public int getMode()
SQLQueryParameterMode.IN
,
SQLQueryParameterMode.OUT
,
SQLQueryParameterMode.INOUT
,public boolean isNullable()
TRUE
if parameter allows nullspublic void setObjectValue(java.lang.Object value)
public java.lang.Object getObjectValue()
Copyright © 2015-2024 StreamScape Technologies. All rights reserved.