|
| |
|
| java.lang.Object
 com.completex.objective.components.persistency.Parameter
com.completex.objective.components.persistency.CallParameter
| CallParameter | | public class CallParameter extends Parameter (Code) | | Represents stored procedure ccall parameter
author:
Gennady Krizhevsky |
| Inner Class :public static class Mode | |
| Inner Class :public static class RefCursorParameter extends CallParameter | |
| Constructor Summary | |
| public | CallParameter(Map parameter)
| | public | CallParameter()
| | public | CallParameter(Object value, Mode mode, int jdbcType)
Parameters:
value - value of this parameter. | | public | CallParameter(Object value, Mode mode, int jdbcType, String jdbcTypeName)
Note that jdbcType and jdbcTypeName are only used for OUT parameters
Parameters:
value - value value of this parameter. | | public | CallParameter(Object value, Mode mode, ColumnType type)
Parameters:
value - value value of this parameter. | | public | CallParameter(Object value, Mode mode, ColumnType type, int jdbcType, String jdbcTypeName)
Note that one may need both ColumnType and jdbcType/jdbcTypeName set. |
| MODE_IN | | final public static Mode MODE_IN(Code) | | Marker for IN call parameter
|
| MODE_INOUT | | final public static Mode MODE_INOUT(Code) | | Marker for IN and OUT call parameter
|
| MODE_OUT | | final public static Mode MODE_OUT(Code) | | Marker for OUT call parameter
|
| PARAMETER_REF_CURSOR | | final public static RefCursorParameter PARAMETER_REF_CURSOR(Code) | | Marker for reference cursor. When setting refernce cursor parameter
always use CallParameter.PARAMETER_REF_CURSOR
|
| TAG_REF_CURSOR | | final public static String TAG_REF_CURSOR(Code) | | |
| CallParameter | | public CallParameter(Map parameter)(Code) | | |
| CallParameter | | public CallParameter(Object value, Mode mode, int jdbcType)(Code) | |
Parameters:
value - value of this parameter. Setting it in constructor only makes sense forIN parameters
Parameters:
mode - one of CallParameter.MODE_XXX fields
Parameters:
jdbcType - one of java.sql.Types types
See Also: java.sql.Types |
| CallParameter | | public CallParameter(Object value, Mode mode, int jdbcType, String jdbcTypeName)(Code) | | Note that jdbcType and jdbcTypeName are only used for OUT parameters
Parameters:
value - value value of this parameter. Setting it in constructor only makes sense forIN parameters
Parameters:
mode - mode one of CallParameter.MODE_XXX fields
Parameters:
jdbcType - one of java.sql.Types types
Parameters:
jdbcTypeName - the fully-qualified name of an SQL structured type
See Also: java.sql.Types |
| CallParameter | | public CallParameter(Object value, Mode mode, ColumnType type)(Code) | |
Parameters:
value - value value of this parameter. Setting it in constructor only makes sense forIN parameters
Parameters:
mode - mode one of CallParameter.MODE_XXX fields
Parameters:
type - column type of the field this parameter corresponds to
See Also: java.sql.Types |
| CallParameter | | public CallParameter(Object value, Mode mode, ColumnType type, int jdbcType, String jdbcTypeName)(Code) | | Note that one may need both ColumnType and jdbcType/jdbcTypeName set. Even though ColumnType
has jdbcType inside it works rather as a default one.
In case the parameter one is set it will take precedence.
We can take as an example when it would we beneficial to have both set the case when
the object field is described as being of ColumnType.OBJECT type but when retrieving
java.sql.Types.Clob is specified and the object field will actually be set to Clob.
Parameters:
value - value value of this parameter. Setting it in constructor only makes sense forIN parameters
Parameters:
mode - mode one of CallParameter.MODE_XXX fields
Parameters:
type - column type of the field this parameter corresponds to
Parameters:
jdbcType - one of java.sql.Types types
Parameters:
jdbcTypeName - the fully-qualified name of an SQL structured type
See Also: java.sql.Types |
| getJdbcScale | | public int getJdbcScale()(Code) | | Returns scale the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.
scale - the desired number of digits to the right of thedecimal point. It must be greater than or equal to zero. |
| getJdbcType | | public int getJdbcType(DatabasePolicy policy)(Code) | | Returns jdbcType one of java.sql.Types types
Parameters:
policy - jdbcType one of java.sql.Types types |
| getJdbcTypeName | | public String getJdbcTypeName(DatabasePolicy policy)(Code) | | Returns jdbcTypeName the fully-qualified name of an SQL structured type
Parameters:
policy - jdbcTypeName the fully-qualified name of an SQL structured type |
| getMode | | public Mode getMode()(Code) | | Returns mode that defines this parameters as being IN/OUT or INOUT - one of CallParameter.MODE_XXX fields
mode that defines this parameters as being IN/OUT or INOUT - one of CallParameter.MODE_XXX fields |
| isIn | | public boolean isIn()(Code) | | Returns true if mode == MODE_IN || mode == MODE_INOUT.
true if mode == MODE_IN || mode == MODE_INOUT. |
| isOut | | public boolean isOut()(Code) | | Returns true if mode == MODE_OUT || mode == MODE_INOUT.
true if mode == MODE_OUT || mode == MODE_INOUT. |
| isRefCursor | | public boolean isRefCursor()(Code) | | Returns true if this is reference cursor OUT parameter
true if this is reference cursor OUT parameter |
| isSkipBackPopulation | | public boolean isSkipBackPopulation()(Code) | | Returns true if the value population for OUT parameter is not needed or desirable
true if the value population for OUT parameter is not needed or desirable |
| setJdbcScale | | public void setJdbcScale(int jdbcScale)(Code) | | Sets scale - the desired number of digits to the right of the
decimal point. It must be greater than or equal to zero.
Parameters:
jdbcScale - the desired number of digits to the right of thedecimal point. It must be greater than or equal to zero. |
| setMode | | public void setMode(Mode mode)(Code) | | Sets mode that defines this parameters as being IN/OUT or INOUT - one of CallParameter.MODE_XXX fields
Parameters:
mode - mode that defines this parameters as being IN/OUT or INOUT - one of CallParameter.MODE_XXX fields |
| setOutValue | | public void setOutValue(Object value)(Code) | | Sets value for OUT parameter. It is called by Persistency after the retrieval.
Parameters:
value - retrieved value
throws:
OdalRuntimePersistencyException - if this is not OUT parameter |
| setSkipBackPopulation | | public void setSkipBackPopulation(boolean skipBackPopulation)(Code) | | Sets true if the value population for OUT parameter is not needed or desirable
Parameters:
skipBackPopulation - true if the value population for OUT parameter is not needed or desirable |
| toMode | | public static Mode toMode(String name)(Code) | | Mode by its name
Parameters:
name - mode name Mode by its name |
|
|
|