diff options
Diffstat (limited to 'tags/java-M1-20060522/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/Command.java')
| -rw-r--r-- | tags/java-M1-20060522/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/Command.java | 222 |
1 files changed, 0 insertions, 222 deletions
diff --git a/tags/java-M1-20060522/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/Command.java b/tags/java-M1-20060522/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/Command.java deleted file mode 100644 index 37d67fd10c..0000000000 --- a/tags/java-M1-20060522/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/Command.java +++ /dev/null @@ -1,222 +0,0 @@ -/** - * - * Copyright 2005 The Apache Software Foundation or its licensors, as applicable. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.apache.tuscany.das.rdb; - -import java.sql.Connection; - -import org.apache.tuscany.das.rdb.impl.CommandFactoryImpl; - -import commonj.sdo.DataObject; -import commonj.sdo.Type; - -/** - * A Command is used to execute a read or write to a database - * - * - */ -public interface Command { - - public static CommandFactory FACTORY = new CommandFactoryImpl(); - - /** - * Performs the function defined by the command - */ - public void execute(); - - /** - * Performs the function defined by the command and return the results in - * the root DataObject - * - * @return the root DataObject - */ - public DataObject executeQuery(); - - /** - * Returns the parameter associated with "name" - * - * @param name - * the name of the parameter - * @return the associated parameter - */ - public Parameter getParameter(String name); - - /** - * Returns the Parameter at index - * - * @param index - * the index of the Parameter - * @return the associated Parameter - */ - public Parameter getParameter(int index); - - /** - * Sets the value of the named Parameter - * - * @param name - * the name of this Parameter - * @param value - * the value for the Parameter - */ - public void setParameterValue(String name, Object value); - - /** - * Sets the value of the associated Parameter - * - * @param index - * the index of the Parameter - * @param value - * the value for the Parameter - */ - public void setParameterValue(int index, Object value); - - /** - * Sets the "type" of the associated Parameter - * - * @param name - * the name of this Parameter - * @param type - * the SDODataTypes-defined "type" for the Parameter. - */ - public void setParameterType(String string, Type dataType); - - /** - * Sets the "type" of the associated Parameter - * - * @param index - * the index of the Parameter - * @param type - * the SDODataTypes-defined "type" for the Parameter. - */ - public void setParameterType(int index, Type dataType); - - /** - * Returns the value of the associated Parameter - * - * @param name - * the name of the Parameter - * @return the value of the Parameter - */ - public Object getParameterValue(String name); - - /** - * Returns the value of the associated Parameter - * - * @param index - * the index of the Parameter - * @return the value of the Parameter - */ - public Object getParameterValue(int index); - - /** - * Adds a Parameter to the command - * - * @param index - * the index of the parameter - * @param sdoType - * the commonj.sdo.Type of the Parameter - */ - public void addParameter(int index, Type sdoType); - - /** - * Adds a Parameter to the command - * - * @param name - * the index of the parameter - * @param sdoType - * the commonj.sdo.Type of the Parameter - */ - public void addParameter(String name, Type sdoType); - - /** - * Adds a Parameter to the command - * - * @param index - * the index of the parameter - * @param direction - * the direction of the Parameter. Either Parameter.IN, - * Parameter.OUT or Parameter.INOUT - * @param sdoType - * specifies the type as a commonj.sdo.Type from - * {@link SDODataTypes} - */ - public void addParameter(int index, int direction, Type sdoType); - - /** - * Adds a Parameter to the command - * - * @param name - * the name associated with the Parameter - * @param direction - * the direction of the Parameter. Either Parameter.IN, - * Parameter.OUT or Parameter.INOUT - * @param sdoType - * specifies the type as a commonj.sdo.Type from - * {@link SDODataTypes} - */ - public void addParameter(String name, int direction, Type sdoType); - - /** - * Specifies an object model for a graph of DataObjects returned by - * #executeQuery() - * - * @param schema - * the model as a commonj.sdo.Type - */ - public void setDataObjectModel(Type schema); - - /** - * Defines the structure of the ResultSet returned by the JDBC Driver when - * this command is executed. If the shape is not specified then the shape is - * taken from the ResultSetMetatadta instance provided by the JDBC Driver. - * <p> - * This method is prvided primarily to support platforms (such as Oracle) - * that do not provide complete support for ResultSetMetadata - * - * @param shape - * the specified result set shape - * @see ResultSetShape - */ - public void setResultSetShape(ResultSetShape shape); - - /** - * Provides the java.sql.Connection to be used for this executing this - * command. - * - * @param connection - * the java.sql.Connection - */ - public void setConnection(Connection connection); - - /** - * Provides the java.sql.Connection to be used for this executing this - * command. - * - * @param connection - * the java.sql.Connection - * @param manageTransactions - * <code>true</code> if the DAS should perform tx - * commit/rollback - */ - public void setConnection(Connection connection, boolean manageTransactions); - - /** - * Cleans up and realeases all resources associated with this command. This - * should be called when the application is done with this command. - */ - public void close(); - -} |