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