org.apache.ojb.otm.Kit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of db-ojb Show documentation

ObJectRelationalBridge (OJB) is an Object/Relational mapping tool that allows transparent persistence for Java Objects against relational databases.

The newest version!

package org.apache.ojb.otm;

/* Copyright 2003-2005 The Apache Software Foundation
 *
 * Licensed 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.
 */

import org.apache.ojb.broker.Identity;
import org.apache.ojb.broker.PBKey;
import org.apache.ojb.otm.copy.ObjectCopyStrategy;
import org.apache.ojb.otm.core.Transaction;
import org.apache.ojb.otm.lock.map.LockMap;
import org.apache.ojb.otm.lock.wait.LockWaitStrategy;
import org.apache.ojb.otm.swizzle.Swizzling;

/**
 *  The Kit provides the point of entry for any OTM client
 *
 *  @author Matthew Baird
 */
public interface Kit
{
    /**
     * Acquire an open OTMConnection
     *
     * @param pbKey
     * @return
     */
	OTMConnection acquireConnection(PBKey pbKey);

    /**
     * Obtain the transaction this connection is bound to
     */
	Transaction getTransaction(OTMConnection conn);

    /**
     * @todo document
     */
	Swizzling getSwizzlingStrategy();

    /**
     * @todo document
     */
	LockWaitStrategy getLockWaitStrategy();

    /**
     * @todo document
     */
	LockMap getLockMap();

    /**
     * @todo document
     */
	ObjectCopyStrategy getCopyStrategy(Identity oid);

    /**
     * @todo document
     */
	boolean isImplicitLockingUsed();

}