org.nuiton.topia.persistence.TopiaTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

ToPIA API module

The newest version!

package org.nuiton.topia.persistence;

/*
 * #%L
 * ToPIA Extension :: API
 * %%
 * Copyright (C) 2018 - 2022 Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

/**
 * This contract represents a transaction and provides methods to manipulate it.
 *
 * @author Arnaud Thimel (Code Lutin)
 * @since 3.0
 */
public interface TopiaTransaction {

    /**
     * Applies all the modifications made to this context on the persistence device.
     *
     * Once commit is done, a new internal transaction is started, but you do not have to get a new instance of
     * {@link TopiaTransaction}.
     */
    void commit();

    /**
     * Cancels all the modifications made to this context, coming back to the state when this transaction has been
     * created (using {@link TopiaApplicationContext#newPersistenceContext()}) or previously rollbacked (using the
     * current method).
     *
     * Once rollback is done, a new internal transaction is started, but you do not have to get a new instance of
     * {@link TopiaTransaction}.
     */
    void rollback();

}