01: /*
02: *
03: * JMoney - A Personal Finance Manager
04: * Copyright (c) 2004 Nigel Westbury <westbury@users.sourceforge.net>
05: *
06: *
07: * This program is free software; you can redistribute it and/or modify
08: * it under the terms of the GNU General Public License as published by
09: * the Free Software Foundation; either version 2 of the License, or
10: * (at your option) any later version.
11: *
12: * This program 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
15: * GNU General Public License for more details.
16: *
17: * You should have received a copy of the GNU General Public License
18: * along with this program; if not, write to the Free Software
19: * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20: *
21: */
22:
23: package net.sf.jmoney.model2;
24:
25: import org.eclipse.ui.IWorkbenchWindow;
26:
27: /**
28: * This interface must be implemented by all plug-ins that implement a
29: * datastore. The methods in this interface are called only from the
30: * framework. They should not be called directly by other plug-ins.
31: * <P>
32: * There will always be one SessionManager object for each Session
33: * object.
34: */
35: public abstract class DatastoreManager extends DataManager {
36:
37: /** Returns a brief description of the data in the session.
38: * This description should be, for example, the file name or the name
39: * of the database where the data either is stored or will be stored
40: * when saved. The framework includes this brief description in
41: * the main window title.
42: *
43: * Null may be returned. (This may be done if, say, the data has
44: * not yet been saved to a file).
45: */
46: public abstract String getBriefDescription();
47:
48: /**
49: * Obtain confirmation and/or information from the user so that this
50: * session can be saved.
51: *
52: * Under certain circumstances, the framework may want to close a session.
53: * For example, when the user opens a new session or when the user exits
54: * the framework. A session may need more information from the user before
55: * it can be saved (for example, a session that is serialized to a file may
56: * not yet have a file name associated with it and so the user must enter
57: * a file name before the session can be saved). A session implementation
58: * may also want the user to confirm before a session is closed.
59: * <P>
60: * This method ensures that all data for the session is saved. However,
61: * the session is still open after
62: * this method has been called. This allows an plug-in action to ensure
63: * a session is saved before starting the process of creating a new
64: * session but still be able to either keep the old session in the event of a failure
65: * or copy data from the previous session to the new session.
66: */
67: public abstract boolean canClose(IWorkbenchWindow window);
68:
69: /**
70: * Close the datastore. Once this method has been called, the session
71: * object is not usable.
72: *
73: * This method should not, in general, contain any interfaces to the user.
74: * If it does, then such user interfaces should not give the user any
75: * opportunity to cancel the operation.
76: */
77: public abstract void close();
78: }
|