01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one
03: * or more contributor license agreements. See the NOTICE file
04: * distributed with this work for additional information
05: * regarding copyright ownership. The ASF licenses this file
06: * to you under the Apache License, Version 2.0 (the
07: * "License"); you may not use this file except in compliance
08: * with the License. You may obtain a copy of the License at
09: *
10: * http://www.apache.org/licenses/LICENSE-2.0
11: *
12: * Unless required by applicable law or agreed to in writing,
13: * software distributed under the License is distributed on an
14: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15: * KIND, either express or implied. See the License for the
16: * specific language governing permissions and limitations
17: * under the License.
18: */
19: package org.apache.openjpa.event;
20:
21: import org.apache.openjpa.kernel.OpenJPAStateManager;
22: import org.apache.openjpa.meta.ValueMetaData;
23:
24: /**
25: * Perform an action when OpenJPA detects an orphaned key in the database.
26: *
27: * @author Abe White
28: * @since 0.3.2.2
29: */
30: public interface OrphanedKeyAction {
31:
32: /**
33: * Callback received when OpenJPA discovers an orphaned key.
34: *
35: * @param oid the orphaned key
36: * @param sm the instance representing the record in which the
37: * key was discovered; may be null
38: * @param vmd the value in which the key was discovered
39: * @return the value to load into field <code>fmd</code>; typically
40: * <code>null</code>
41: */
42: public Object orphan(Object oid, OpenJPAStateManager sm,
43: ValueMetaData vmd);
44: }
|