openjpa-kernel/src/main/java/org/apache/openjpa/kernel/FindCallbacks.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.openjpa.kernel;

/**
 * Allows facades to control the particulars of the find operation
 * through callbacks.
 *
 * @author Abe White
 */
public interface FindCallbacks {

    /**
     * Process find argument. Throw proper
     * {@link org.apache.openjpa.util.OpenJPAException} for illegal value.
     *
     * @return the id to look up, or null to ignore this argument
     */
    Object processArgument(Object oid);

    /**
     * Process operation return value.
     *
     * @return the object to return
     */
    Object processReturn(Object oid, OpenJPAStateManager sm);
}