View Javadoc

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