01: /*
02: * ====================================================================
03: * JAFFA - Java Application Framework For All
04: *
05: * Copyright (C) 2002 JAFFA Development Group
06: *
07: * This library is free software; you can redistribute it and/or
08: * modify it under the terms of the GNU Lesser General Public
09: * License as published by the Free Software Foundation; either
10: * version 2.1 of the License, or (at your option) any later version.
11: *
12: * This library is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this library; if not, write to the Free Software
19: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20: *
21: * Redistribution and use of this software and associated documentation ("Software"),
22: * with or without modification, are permitted provided that the following conditions are met:
23: * 1. Redistributions of source code must retain copyright statements and notices.
24: * Redistributions must also contain a copy of this document.
25: * 2. Redistributions in binary form must reproduce the above copyright notice,
26: * this list of conditions and the following disclaimer in the documentation
27: * and/or other materials provided with the distribution.
28: * 3. The name "JAFFA" must not be used to endorse or promote products derived from
29: * this Software without prior written permission. For written permission,
30: * please contact mail to: jaffagroup@yahoo.com.
31: * 4. Products derived from this Software may not be called "JAFFA" nor may "JAFFA"
32: * appear in their names without prior written permission.
33: * 5. Due credit should be given to the JAFFA Project (http://jaffa.sourceforge.net).
34: *
35: * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
36: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46: * SUCH DAMAGE.
47: * ====================================================================
48: */
49:
50: package org.jaffa.persistence.engines.jdbcengine;
51:
52: import org.jaffa.persistence.*;
53:
54: /** This is the interface for a StoredProcedure. */
55: public interface IStoredProcedure extends IPersistent {
56:
57: /** A static for denoting an INPUT parameter of a StoredProcedure */
58: public static final int IN = 0x01;
59:
60: /** A static for denoting an OUTPUT parameter of a StoredProcedure */
61: public static final int OUT = 0x02;
62:
63: /** A static for denoting an INPUT/OUTPUT parameter of a StoredProcedure */
64: public static final int BOTH = 0x03;
65:
66: /** The implementing class should return an array of field names,
67: * which correspond to the parameters of the StoredProcedure.
68: * The implementing class should provide Getters/Setters for these fields.
69: * @return An array of parameters to the StoredProcedure.
70: */
71: public String[] getParameters();
72:
73: /** The implementing class should return an array of Strings signifying the SQL type
74: * for each of the parameter returned in the getParameters() method.
75: * eg. VARCHAR, BOOLEAN etc. etc. These should be the same as those defined in the mapping files
76: * @return An array of Strings signifying the SQL type of the parameters.
77: */
78: public String[] getParamSqlTypes();
79:
80: /** The implementing class should return an array of integers signifying the directions (input, output or input/output)
81: * for each of the parameter returned in the getParameters() method.
82: * @return An array of integers signifying the directions of the parameters.
83: */
84: public int[] getParamDirections();
85:
86: /** The implementing class will return a String having the call to the StoredProcedure.
87: * For eg. To invoke the 'ke_vcpkg1.getvoucher' StoredProcedure, which takes 3 parameters, this method
88: * will return the string "{call ke_vcpkg1.getvoucher(?,?,?)}".
89: * @return a String having the call to the StoredProcedure.
90: */
91: public String prepareCall();
92:
93: }
|