/*
 * IronJacamar, a Java EE Connector Architecture implementation
 * Copyright 2015, Red Hat Inc, and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the Eclipse Public License 1.0 as
 * published by the Free Software Foundation.
 *
 * This software 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 Eclipse
 * Public License for more details.
 *
 * You should have received a copy of the Eclipse Public License 
 * along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.ironjacamar.rars.txlog;

/**
 * TxLogConnection
 */
public interface TxLogConnection
{
   /**
    * Get id
    * @return The identifier
    */
   public String getId();

   /**
    * Get state
    * @return The state string
    */
   public String getState();

   /**
    * Get state
    * @param id The identifier
    * @return The state string
    */
   public String getState(String id);

   /**
    * Clear state
    */
   public void clearState();

   /**
    * Clear state
    * @param id The identifier
    */
   public void clearState(String id);

   /**
    * Is in pool
    * @return The value
    */
   public boolean isInPool();

   /**
    * Is recovery
    * @return The value
    */
   public boolean isRecovery();

   /**
    * Get the transaction timeout
    * @return The value
    */
   public int getTransactionTimeout();

   /**
    * Set the transaction timeout
    * @param v The value
    * @return The result
    */
   public boolean setTransactionTimeout(int v);

   /**
    * Close
    */
   public void close();

   /**
    * Fail
    */
   public void fail();
}