View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at 
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software 
11   * distributed under the License is distributed on an "AS IS" BASIS, 
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13   * See the License for the specific language governing permissions and 
14   * limitations under the License.
15   */
16  
17  /*
18   * StoreCallback.java
19   *
20   */
21   
22  package javax.jdo.listener;
23  
24  /***
25   * This interface is used to notify instances of store events.
26   * @version 2.0
27   * @since 2.0
28   */
29  public interface StoreCallback {
30      
31      /***
32       * Called before the values are stored from this instance to the
33       * data store.
34       *
35       * <P>Data store fields that might have been affected by modified
36       * non-persistent fields should be updated in this method.
37       *
38       * <P>This method is modified by the enhancer so that changes to 
39       * persistent fields will be reflected in the data store. 
40       * The context in which this call is made allows access to the 
41       * <code>PersistenceManager</code> and other persistent JDO instances.
42       */
43      void jdoPreStore();
44  }