001/*
002 * Copyright 2002-2019 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.transaction;
018
019/**
020 * Common representation of the current state of a transaction.
021 * Serves as base interface for {@link TransactionStatus} as well as
022 * {@link ReactiveTransaction}.
023 *
024 * @author Juergen Hoeller
025 * @since 5.2
026 */
027public interface TransactionExecution {
028
029        /**
030         * Return whether the present transaction is new; otherwise participating
031         * in an existing transaction, or potentially not running in an actual
032         * transaction in the first place.
033         */
034        boolean isNewTransaction();
035
036        /**
037         * Set the transaction rollback-only. This instructs the transaction manager
038         * that the only possible outcome of the transaction may be a rollback, as
039         * alternative to throwing an exception which would in turn trigger a rollback.
040         */
041        void setRollbackOnly();
042
043        /**
044         * Return whether the transaction has been marked as rollback-only
045         * (either by the application or by the transaction infrastructure).
046         */
047        boolean isRollbackOnly();
048
049        /**
050         * Return whether this transaction is completed, that is,
051         * whether it has already been committed or rolled back.
052         */
053        boolean isCompleted();
054
055}