com.simba.dsi.ext
Class ProcedureParameterMetadata

java.lang.Object
  extended by com.simba.dsi.dataengine.utilities.ParameterMetadata
      extended by com.simba.dsi.ext.ProcedureParameterMetadata

public final class ProcedureParameterMetadata
extends ParameterMetadata

A ProcedureParameterMetadata describes a single parameter for a stored procedure.


Field Summary
 
Fields inherited from class com.simba.dsi.dataengine.utilities.ParameterMetadata
m_columnLength, m_isCaseSensitive, m_name, m_nullable, m_parameterNumber, m_parameterType, m_typeMetadata
 
Constructor Summary
ProcedureParameterMetadata(int parameterNumber, ParameterType parameterType, int sqlType, boolean hasDefaultValue)
          Constructor.
ProcedureParameterMetadata(int parameterNumber, ParameterType parameterType, int sqlType, boolean hasDefaultValue, boolean isSigned)
          Constructor.
 
Method Summary
 boolean hasDefaultValue()
          Indicates whether the parameter has a default value that is used if no value is supplied for the argument in the stored procedure.
 
Methods inherited from class com.simba.dsi.dataengine.utilities.ParameterMetadata
getColumnLength, getEquivalentColumnMeta, getName, getNullable, getParameterNumber, getParameterType, getTypeMetadata, isCaseSensitive, isUnnamed, setCaseSensitive, setColumnLength, setConvertInputToString, setName, setNullable, shouldConvertInputToString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ProcedureParameterMetadata

public ProcedureParameterMetadata(int parameterNumber,
                                  ParameterType parameterType,
                                  int sqlType,
                                  boolean hasDefaultValue)
                           throws com.simba.support.exceptions.ErrorException
Constructor.

Parameters:
parameterNumber - Parameter index, starting with 0.
parameterType - Indicates if the parameter is for input, output, or both.
sqlType - The SQL type of the parameter.
hasDefaultValue - Indicates if the parameter has a default value.
Throws:
com.simba.support.exceptions.ErrorException

ProcedureParameterMetadata

public ProcedureParameterMetadata(int parameterNumber,
                                  ParameterType parameterType,
                                  int sqlType,
                                  boolean hasDefaultValue,
                                  boolean isSigned)
                           throws com.simba.support.exceptions.ErrorException
Constructor.

Parameters:
parameterNumber - Parameter index, starting with 0.
parameterType - Indicates if the parameter is for input, output, or both.
sqlType - The SQL type of the parameter.
hasDefaultValue - Indicates if the parameter has a default value.
isSigned - Indicates if the parameter is signed.
Throws:
com.simba.support.exceptions.ErrorException
Method Detail

hasDefaultValue

public boolean hasDefaultValue()
Indicates whether the parameter has a default value that is used if no value is supplied for the argument in the stored procedure.

Returns:
true if the parameter has a default value; false otherwise.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.