/*
 *  Copyright (c) 2005-2014, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
 *
 *  WSO2 Inc. licenses this file to you under the Apache License,
 *  Version 2.0 (the "License"); you may not use this file except
 *  in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */
package org.wso2.carbon.dataservices.core;

/**
 * This class represents a data services connection used when storing in TL storage for transactions. 
 */
public interface DataServiceConnection {

    /**
     * Checks and commits the current connection if it is commitable. 
     * @throws DataServiceFault
     */
    void commit() throws DataServiceFault;
    
    /**
     * Rollback the connection.
     * @throws DataServiceFault
     */
    void rollback() throws DataServiceFault;
    
    /**
     * Close the connection.
     * @throws DataServiceFault
     */
    void close() throws DataServiceFault;
    
    /**
     * Returns whether this is a connection that participates in a JTA transaction.
     * @return XA compatible connection or not
     */
    boolean isXA();

    /**
     * Returns information of the the connection object.
     * @return  a string representation of the object
     */
    String toString();
    
}