01: /* Copyright 2004 The JA-SIG Collaborative. All rights reserved.
02: * See license distributed with this file and
03: * available online at http://www.uportal.org/license.html
04: */
05:
06: package org.jasig.portal.rdbm;
07:
08: import java.sql.SQLException;
09:
10: /**
11: * The join query interface defines methods for storing and retrieving
12: * queries fragments that will be used for performing joins in SQL.
13: *
14: * @author Eric Dalquist <a href="mailto:edalquist@unicon.net">edalquist@unicon.net</a>
15: * @version $Revision: 34769 $ $Date: 2004-10-17 12:43:50 -0700 (Sun, 17 Oct 2004) $
16: */
17: public interface IJoinQueryString {
18: /**
19: * Gets a query by the specified key.
20: *
21: * @param key The key to find the query for.
22: * @return The query for the key.
23: * @throws SQLException Will be thrown if no query exists for the key
24: */
25: public String getQuery(String key) throws SQLException;
26:
27: /**
28: * Adds a query for the specified key, overwriting and query that was
29: * already associated with the key.
30: *
31: * @param key The key to store the query under.
32: * @param value The query to store under the key.
33: * @throws SQLException
34: */
35: public void addQuery(String key, String value) throws SQLException;
36: }
|