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   * DetachLifecycleListener.java
20   *
21   */
22   
23  package javax.jdo.listener;
24  
25  /**
26   * This interface is implemented by listeners to be notified of
27   * detach events.
28   * @version 2.0
29   * @since 2.0
30   */
31  public interface DetachLifecycleListener
32      extends InstanceLifecycleListener {
33      
34      /** 
35       * This method is called during the execution of 
36       * {@link javax.jdo.PersistenceManager#detachCopy} before the 
37       * detached copy is made. It is called before the method
38       * {@link DetachCallback#jdoPreDetach} is called on the
39       * instance to be detached.
40       * @param event the detach event.
41       * @since 2.0
42       */
43      void preDetach (InstanceLifecycleEvent event);
44      
45      /**
46       * This method is called during the execution of
47       * {@link javax.jdo.PersistenceManager#detachCopy} after the 
48       * detached copy is made. It is called after the method
49       * {@link DetachCallback#jdoPreDetach} is called on
50       * the detached instance.
51       * @param event the detach event.
52       * @since 2.0
53       */
54      void postDetach (InstanceLifecycleEvent event); 
55  }