01: /* ----- BEGIN LICENSE BLOCK -----
02: * Version: MPL 1.1
03: *
04: * The contents of this file are subject to the Mozilla Public License Version
05: * 1.1 (the "License"); you may not use this file except in compliance with
06: * the License. You may obtain a copy of the License at
07: * http://www.mozilla.org/MPL/
08: *
09: * Software distributed under the License is distributed on an "AS IS" basis,
10: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11: * for the specific language governing rights and limitations under the
12: * License.
13: *
14: * The Original Code is the DataShare server.
15: *
16: * The Initial Developer of the Original Code is
17: * Ball Aerospace & Technologies Corp, Fairborn, Ohio
18: * Portions created by the Initial Developer are Copyright (C) 2001
19: * the Initial Developer. All Rights Reserved.
20: *
21: * Contributor(s): Charles Wood <cwood@ball.com>
22: *
23: * ----- END LICENSE BLOCK ----- */
24: /* RCS $Id: PersistDataCallbackInterface.java,v 1.1.1.1 2001/10/23 13:37:18 lizellaman Exp $
25: * $Log: PersistDataCallbackInterface.java,v $
26: * Revision 1.1.1.1 2001/10/23 13:37:18 lizellaman
27: * initial sourceforge release
28: *
29: */
30:
31: package org.datashare;
32:
33: /**
34: * Defines the methods that allow a class that wishes to create an EJB in background to be notified
35: * when the EJB has been completed. This includes a method that lets us know the EJB is currently
36: * in creation, and methods that allow the EJB that was created to have it's key value returned.
37: *
38: * @date March 01, 2001
39: * @author Charles Wood
40: * @version 1.0
41: */
42: public interface PersistDataCallbackInterface {
43:
44: /**
45: * Used to set the value that represents if the EJB has been created and it's
46: * corresponding ADSKey value set into the invoking class via the setADSKey() method.
47: *
48: * @param value true if the ADSKey has been returned, false if we are still
49: * waiting
50: */
51: void setKeyHasBeenReturned(boolean value);
52:
53: /**
54: *
55: * Indicates the status of the EJB that was requested to be created: this method
56: * is called with a true value while we are waiting for the EJB to be created, and
57: * set to false after the EJB has been created and it's ADSKey String value has been
58: * returned via the setEjbId method. Note that to truly determine if the ADSKey String
59: * value has been completed, this method will return a false and the method
60: * getKeyHasBeenReturned will return true.
61: *
62: * @param value true if the EJB has not been completed, false otherwise.
63: */
64: void setWaitingForKey(boolean value);
65:
66: /**
67: * called by the class that creates the EJB after the EJB has been created and the
68: * ADSKey String that corresponds to it has been made available.
69: *
70: * @param databaseID the ADSKey String for the EJB that was created
71: */
72: void setDatabaseID(String databaseID);
73: }
|