Please tell me examples of how defineNamedWhereClauseParam is used

Question

Hi,
Following APIs added to oracle.jbo.RowSet in JDev10.1.3
- void defineNamedWhereClauseParam(String name, Object defaultValue, int[] indices);
- void removeNamedWhereClauseParam(String name);
- void setNamedWhereClauseParam(String name, Object value);
- void skipNamedWhereClauseParam(String name);
Please tell me examples of how defineNamedWhereClauseParam is used.
Thanks

Answer 1

Hi,
the Javdoc that are available on OTN (http://download-east.oracle.com/docs/cd/B25221_04/web.1013/b16005/index.html) say
defineNamedWhereClauseParam
public void defineNamedWhereClauseParam(java.lang.String name,
java.lang.Object defaultValue,
int[] indices)
Defines a named bind variable to use with the view object's where-clause.
This named where-clause parameter will be defined as a variable on the view object. That is, if a named where-clause parameter is defined through one row set, all other row sets that belongs to the same parent view object will "see" that parameter.
Through the defaultValue, one can specify the default value for this where-clause parameter. If no default value is supplied, null will be used as the parameter value.
The indices parameter specifies where-clause parameter indices into which this named parameter will be bound. The same value can be bound into multiple indices. For example, if { 1, 2 } is specified for indices, the value will be bound for where-clause parameter indices of 1 and 2. I.e., this parameter will produce setWhereClauseParam(1, value) and setWhereClauseParam(2, value).
This method can be invoked to redefine an existing named where-clause paramter (to change the default value and the indices) only if the named parameter is found on the view object. If the named parameter/variable is found on one of the parent objects, a new where-clause parameter definition is still added to the view object.
When redefining, a check is made to ensure that the existing variable has no kind specification (null) or is of the "where" kind (which means that the existing variable is a where-clause parameter). If not, an InvalidParamException is thrown.
Defining a named where-clause parameter does not automatically execute the query. You must call executeQuery() to apply the new bind value.
Parameters:
name - the name of the where-clause parameter.
defaultValue - specifies the default value for this where-clause parameter. This default value can be overridden through a call to setNamedWhereClauseParam().
indices - where-clause indices into which this parameter value should be bound. See above.
Throws:
InvalidParamException - if this method is being called to redefine an old parameter and the variable turns out not to be a where-clause parameter.
removeNamedWhereClauseParam
public void removeNamedWhereClauseParam(java.lang.String name)
Removes a named where-clause parameter.
This method removes previously defined named where-clause parameter. A check is made to ensure that the variable being removed is a where-clause parameter (variable kind = "where"). If not, an InvalidParamException is thrown.
If the named where-clause parameter is found but it does not belong to the view object that owns this row set, an InvalidOperException is thrown. This means one is disallowed from removing a named where-clause parameter that belongs to the View definition, for example.
Removing a named where-clause parameter does not automatically execute the query. You must call executeQuery() for the removal to take effect.
Parameters:
name - the name of the where-clause parameter to remove.
Throws:
InvalidParamException - if the specified variable is not a where-clause parameter.
InvalidOperException - if the specified variable does not belong to the view object that owns this row set.
setNamedWhereClauseParam
public void setNamedWhereClauseParam(java.lang.String name,
java.lang.Object value)
Sets the value of a named where-clause parameter for this row set.
If the view object owns multiple row sets, each row set may have its own (different) named where-clause parameter value.
Setting a named where-clause parameter does not automatically execute the query. You must call executeQuery() to apply the new bind value.
Parameters:
name - the name of the where-clause parameter.
value - the where-clause parameter value for this row set.
Throws:
InvalidParamException - if the named variable turns out not to be a where-clause parameter.
NoDefException - if the named where-clause parameter does not exist.
skipNamedWhereClauseParam
public void skipNamedWhereClauseParam(java.lang.String name)
Skips the named where-clause parameter for this row set. This method does not remove the named where-clause parameter. However, it "masks out" the named where-clause parameter, so that the parameter is skipped when the query is executed.
Skipping a named where-clause parameter does not automatically execute the query. You must call executeQuery() for the skip to take effect.
Parameters:
name - the name of the where-clause parameter.
Throws:
InvalidParamException - if the named variable turns out not to be a where-clause parameter.
NoDefException - if the named where-clause parameter does not exist.
Frank