Source code: com/virtuosotechnologies/asaph/maingui/DatabaseHandler.java
1 /*
2 ================================================================================
3
4 FILE: DatabaseHandler.java
5
6 PROJECT:
7
8 Asaph
9
10 CONTENTS:
11
12 Implement this interface to handle events related to an opened database
13
14 PROGRAMMERS:
15
16 Daniel Azuma (DA) <dazuma@kagi.com>
17
18 COPYRIGHT:
19
20 Copyright (C) 2003 Daniel Azuma (dazuma@kagi.com)
21
22 This program is free software; you can redistribute it and/or
23 modify it under the terms of the GNU General Public License as
24 published by the Free Software Foundation; either version 2
25 of the License, or (at your option) any later version.
26
27 This program is distributed in the hope that it will be useful,
28 but WITHOUT ANY WARRANTY; without even the implied warranty of
29 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30 GNU General Public License for more details.
31
32 You should have received a copy of the GNU General Public
33 License along with this program; if not, write to
34 Free Software Foundation, Inc.
35 59 Temple Place, Suite 330
36 Boston, MA 02111-1307 USA
37
38 ================================================================================
39 */
40
41
42 package com.virtuosotechnologies.asaph.maingui;
43
44
45 /**
46 * Implement this interface to handle events related to an opened database
47 */
48 public interface DatabaseHandler
49 {
50 /**
51 * This is called when something attempts to mark this database dirty.
52 * The connection should make a determination whether it makes sense to mark
53 * the database as dirty, and it should return true or false depending on
54 * whether it is being dirtied or not.
55 *
56 * @return true if the database should be marked dirty
57 */
58 public boolean handleDatabaseDirtied();
59
60
61 /**
62 * This is called when the user double-clicks or selects "Get Info" on this
63 * database. The connection should typically respond by opening a pane with a
64 * description of the database, such as its size, location, URI and other
65 * attributes.
66 */
67 public void handleDatabaseGetInfo();
68
69
70 /**
71 * This method is called when the main gui wants to close this database. The
72 * connection may veto the close (for example, if the user cancels a save) by
73 * returning false. Returning true indicates to the main gui that it can remove
74 * the database from its list.
75 *
76 * @return true if the close was successful, or false if aborted.
77 */
78 public boolean handleDatabaseClosing();
79 }