com.alachisoft.ncache.runtime.dependencies
Class SqlCmdParams

java.lang.Object
  extended by com.alachisoft.ncache.runtime.dependencies.SqlCmdParams

public class SqlCmdParams
extends java.lang.Object

Describes the type of the parameters passed to the command.


Constructor Summary
SqlCmdParams()
           
 
Method Summary
 CmdParamsType getCmdParamsType()
          Gets the SqlDbType of the passed parameter.
 SqlCmpOptions getCompareInfo()
           
 boolean getIsNullable()
          Gets a value that indicates whether the parameter accepts null values.
 int getLocaleId()
          Gets the locale identifier that determines conventions and language for a particular region.
 int getoffset()
          Gets the offset to the Value property.
 byte getPrecision()
          Gets the maximum number of digits used to represent the Value property.
 byte getScale()
          Gets the number of decimal places to which Value is resolved.
 int getSize()
          Gets the maximum size, in bytes, of the data within the column.
 java.lang.String getSourceColumn()
          Gets the name of the source column mapped to the DataSet and used for loading or returning the Value.
 boolean getSourceColumnNullMapping()
          Gets a value which indicates whether the source column is nullable.
 SqlDataRowVersion getSourceVersion()
           
 SqlParamDirection getSqlParameterDirection()
          Gets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
 java.lang.Object getSqlValue()
          Gets the value of the parameter as an SQL type.
 java.lang.String getTypeName()
          Gets the type name for a table-valued parameter.
 java.lang.String getUdtTypeName()
          Gets a string that represents a user-defined type as a parameter.
 java.lang.Object getValue()
          The value of the passed parameter.
 void setCmdParamsType(CmdParamsType type)
          Sets the SqlDbType of the passed parameter.
 void setCompareInfo(SqlCmpOptions compareInfo)
          Sets the CompareInfo object that defines how string comparisons should be performed for this parameter.
 void setIsNullable(boolean isNullable)
          Sets a value that indicates whether the parameter accepts null values.
 void setLocaleId(int localeId)
          Sets the locale identifier that determines conventions and language for a particular region.
 void setoffset(int offset)
          Sets the offset to the Value property.
 void setprecision(byte precision)
          Sets the maximum number of digits used to represent the Value property.
 void setScale(byte scale)
          Sets the number of decimal places to which Value is resolved.
 void setSize(int size)
          Sets the maximum size, in bytes, of the data within the column.
 void setSourceColumn(java.lang.String sourceColumn)
          Sets the name of the source column mapped to the DataSet and used for loading or returning the Value.
 void setSourceColumnNullMapping(boolean sourceColumnNullMapping)
          Sets a value which indicates whether the source column is nullable.
 void setSourceVersion(SqlDataRowVersion sourceVersion)
          Sets the DataRowVersion to use when you load Value
 void setSqlParameterDirection(SqlParamDirection direction)
          Sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.
 void setSqlValue(java.lang.Object sqlValue)
          Sets the value of the parameter as an SQL type.
 void setTypeName(java.lang.String typeName)
          Sets the type name for a table-valued parameter.
 void setUdtTypeName(java.lang.String UdtTypeName)
          Sets a string that represents a user-defined type as a parameter.
 void setValue(java.lang.Object value)
          The value of the passed parameter.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SqlCmdParams

public SqlCmdParams()
Method Detail

getCmdParamsType

public CmdParamsType getCmdParamsType()
Gets the SqlDbType of the passed parameter.

Returns:

getCompareInfo

public SqlCmpOptions getCompareInfo()

getIsNullable

public boolean getIsNullable()
Gets a value that indicates whether the parameter accepts null values.

Returns:

getLocaleId

public int getLocaleId()
Gets the locale identifier that determines conventions and language for a particular region.

Returns:

getoffset

public int getoffset()
Gets the offset to the Value property.

Returns:

getPrecision

public byte getPrecision()
Gets the maximum number of digits used to represent the Value property.

Returns:

getScale

public byte getScale()
Gets the number of decimal places to which Value is resolved.

Returns:

getSize

public int getSize()
Gets the maximum size, in bytes, of the data within the column.

Returns:

getSourceColumn

public java.lang.String getSourceColumn()
Gets the name of the source column mapped to the DataSet and used for loading or returning the Value.

Returns:

getSourceColumnNullMapping

public boolean getSourceColumnNullMapping()
Gets a value which indicates whether the source column is nullable. This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

Returns:

getSourceVersion

public SqlDataRowVersion getSourceVersion()

getSqlParameterDirection

public SqlParamDirection getSqlParameterDirection()
Gets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

Returns:

getSqlValue

public java.lang.Object getSqlValue()
Gets the value of the parameter as an SQL type.

Returns:

getTypeName

public java.lang.String getTypeName()
Gets the type name for a table-valued parameter.

Returns:

getUdtTypeName

public java.lang.String getUdtTypeName()
Gets a string that represents a user-defined type as a parameter.

Returns:

getValue

public java.lang.Object getValue()
The value of the passed parameter.

Returns:

setCmdParamsType

public void setCmdParamsType(CmdParamsType type)
Sets the SqlDbType of the passed parameter.

Parameters:
type -

setCompareInfo

public void setCompareInfo(SqlCmpOptions compareInfo)
Sets the CompareInfo object that defines how string comparisons should be performed for this parameter.

Parameters:
compareInfo -

setIsNullable

public void setIsNullable(boolean isNullable)
Sets a value that indicates whether the parameter accepts null values.

Parameters:
isNullable -

setLocaleId

public void setLocaleId(int localeId)
Sets the locale identifier that determines conventions and language for a particular region.

Parameters:
localeId -

setoffset

public void setoffset(int offset)
Sets the offset to the Value property.

Parameters:
offset -

setprecision

public void setprecision(byte precision)
Sets the maximum number of digits used to represent the Value property.

Parameters:
precision -

setScale

public void setScale(byte scale)
Sets the number of decimal places to which Value is resolved.

Parameters:
scale -

setSize

public void setSize(int size)
Sets the maximum size, in bytes, of the data within the column.

Parameters:
size -

setSourceColumn

public void setSourceColumn(java.lang.String sourceColumn)
Sets the name of the source column mapped to the DataSet and used for loading or returning the Value.

Parameters:
sourceColumn -

setSourceColumnNullMapping

public void setSourceColumnNullMapping(boolean sourceColumnNullMapping)
Sets a value which indicates whether the source column is nullable. This allows SqlCommandBuilder to correctly generate Update statements for nullable columns.

Parameters:
sourceColumnNullMapping -

setSourceVersion

public void setSourceVersion(SqlDataRowVersion sourceVersion)
Sets the DataRowVersion to use when you load Value

Parameters:
sourceVersion -

setSqlParameterDirection

public void setSqlParameterDirection(SqlParamDirection direction)
Sets a value that indicates whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

Parameters:
direction -

setSqlValue

public void setSqlValue(java.lang.Object sqlValue)
Sets the value of the parameter as an SQL type.

Parameters:
sqlValue -

setTypeName

public void setTypeName(java.lang.String typeName)
Sets the type name for a table-valued parameter.

Parameters:
typeName -

setUdtTypeName

public void setUdtTypeName(java.lang.String UdtTypeName)
Sets a string that represents a user-defined type as a parameter.

Parameters:
UdtTypeName -

setValue

public void setValue(java.lang.Object value)
The value of the passed parameter.

Parameters:
value -