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   * AttachLifecycleListener.java
19   *
20   */
21   
22  package javax.jdo.listener;
23  
24  import javax.jdo.PersistenceManager;
25  
26  /***
27   * This interface is implemented by listeners to be notified of
28   * attach events.
29   * @version 2.0
30   * @since 2.0
31   */
32  public interface AttachLifecycleListener
33      extends InstanceLifecycleListener {
34      
35      /***
36       * This method is called before a detached instance is attached, via the
37       * {@link PersistenceManager#makePersistent} method. The source instance
38       * is the detached instance. This method is called before the
39       * corresponding {@link AttachCallback#jdoPreAttach} on the detached
40       * instance.
41       * @param event the attach event.
42       * @since 2.0
43       */
44      void preAttach (InstanceLifecycleEvent event);
45      
46      /***
47       * This method is called after a detached instance is attached, via the
48       * {@link PersistenceManager#makePersistent} method. The source
49       * instance is the corresponding persistent instance in the cache; the
50       * target instance is the detached instance. This method is called after
51       * the corresponding {@link AttachCallback#jdoPostAttach} on the
52       * persistent instance.
53       * @param event the attach event.
54       * @since 2.0
55       */
56      void postAttach (InstanceLifecycleEvent event);
57  }