01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.modules.sql.framework.model;
42:
43: /**
44: * UI wrapper class for SQLObjects which serve as inputs to SQLConnectableObjects.
45: *
46: * @author Jonathan Giron
47: * @version $Revision$
48: */
49: public interface SQLInputObject {
50:
51: public static String ATTR_ARGNAME = "argName";
52:
53: public static String ATTR_DISPLAY_NAME = "displayName";
54:
55: public static String TAG_INPUT = "input";
56:
57: /**
58: * Gets argument name associated with this input.
59: *
60: * @return argument name
61: */
62: public String getArgName();
63:
64: /**
65: * Gets display name of this input.
66: *
67: * @return current display name
68: */
69: public String getDisplayName();
70:
71: /**
72: * Gets reference to SQLObject holding value of this input
73: *
74: * @return input object
75: */
76: public SQLObject getSQLObject();
77:
78: /**
79: * Sets display name of this input.
80: *
81: * @param newName new display name
82: */
83: public void setDisplayName(String newName);
84:
85: /**
86: * Sets reference to SQLObject holding value of this input
87: *
88: * @param newInput reference to new input object
89: */
90: public void setSQLObject(SQLObject newInput);
91:
92: /**
93: * Writes contents of this instance to an XML element.
94: *
95: * @param prefix String to prepend to the start of each new line
96: * @return XML element representing the contents of this instance
97: */
98: public String toXMLString(String prefix);
99: }
|