001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.transaction;
020
021/** Bit-flag constants returned by {@link TransactionParticipant} lifecycle methods to signal outcomes. */
022public interface TransactionConstants {
023    /** Transaction has been aborted. */
024    int ABORTED  = 0;
025    /** Transaction has been prepared successfully. */
026    int PREPARED = 1;
027    /** Transaction should be retried. */
028    int RETRY    = 2;
029    /** Transaction is paused. */
030    int PAUSE    = 4;
031
032    /**
033     * This participant does not join the transaction
034     */
035    int NO_JOIN  = 0x40;
036
037    /**
038     * Context has not been modified (no need to persist a snapshot)
039     */
040    int READONLY = 0x80;
041
042    /** Shortcut for a read-only, non-joining abort ({@code READONLY | NO_JOIN}). */
043    int FAIL = READONLY | NO_JOIN; // shortcut to heavily used action combination - assumes ABORTED == 0
044}