Files
alfresco-community-repo/source/java/org/alfresco/repo/domain/control/ControlDAO.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

113 lines
4.0 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
* #L%
*/
package org.alfresco.repo.domain.control;
import java.sql.Savepoint;
/**
* DAO services for database control statements. It is sometimes necessary to
* issue control statements on a database connection; these are not usually
* supported in the ANSI SQL standard.
*
* @author Derek Hulley
* @since 3.2SP1
*/
public interface ControlDAO
{
/**
* Begin batching prepared statements for later execution.
*
* @see #executeBatch()
*/
public void startBatch();
/**
* Execute statements that were queued for batching.
*
* @see #startBatch()
*/
public void executeBatch();
/**
* Create a "Save Point" in the current transaction, for later selective rollback.
* Creation <b>must</b> be accompanied by a matching {@link #rollbackToSavepoint(Savepoint)}
* or {@link #releaseSavepoint(Savepoint)}.
* <code><pre>
* Savepoint savepoint = controlDAO.createSavepoint("functionF");
* try
* {
* // Do something that could fail e.g. blind insert that might violate unique constraints
* ...
* // Success, so remove savepoint or risk crashing on long-running transactions
* controlDAO.releaseSavepoint(savepoint);
* }
* catch (Throwable e)
* {
* controlDAO.rollbackToSavepoint(savepoint);
* // Throw something that client code might be able to react to or try something else
* ...
* }
* </pre></code>
*
* @param savepoint the name of the save point
* @return Returns the handle to the savepoint or <tt>null</tt> if the
* implementation does not support it
*/
public Savepoint createSavepoint(String savepoint);
/**
* Roll back to a previously-created "Save Point", discarding any intervening
* changes to the current transaction.
*
* @param savepoint a previously-created savepoint
*
* @see #createSavepoint(String)
*/
public void rollbackToSavepoint(Savepoint savepoint);
/**
* Remove a previously-created "Save Point", writing any intervening updates
* into the current transaction.
*
* @param savepoint the name of the save point
*
* @see #createSavepoint(String)
*/
public void releaseSavepoint(Savepoint savepoint);
/**
* Change the current transaction isolation level.
* <p/>
* <b>Note:</b> The isolation level should not - and for some DBs, cannot - be changed
* except at the very start of the transaction
*
* @param isolationLevel the transaction isolation level
* @return Returns the previously-set isolation
* @throws IllegalStateException if the isolation level is invalid or cannot be changed
*/
public int setTransactionIsolationLevel(int isolationLevel);
}