org.objectweb.perseus.fos.api
Interface FosTransaction

All Superinterfaces:
FosAccess
All Known Implementing Classes:
FosTxContext

public interface FosTransaction
extends FosAccess

Defines the means to operate FOS transactions.

Author:
S. Chassande-Barrioz, P. Déchamboux

Method Summary
 void begin()
          Begins a FOS transaction with no DTP context.
 void begin(javax.transaction.xa.Xid xid)
          Begins a FOS transaction with a DTP context.
 void commit()
          Commits a FOS transaction.
 boolean isActive()
          Specifies if this FOS transaction is active or not.
 boolean prepare()
          Prepares a FOS transaction for commit.
 void rollback()
          Roolbacks a FOS transaction.
 
Methods inherited from interface org.objectweb.perseus.fos.api.FosAccess
delete, deleteDir, exist, existDir, read, scan, write
 

Method Detail

begin

public void begin()
           throws FosException
Begins a FOS transaction with no DTP context.

Throws:
FosException

begin

public void begin(javax.transaction.xa.Xid xid)
           throws FosException
Begins a FOS transaction with a DTP context.

Parameters:
xid - The DTP identifier associated with this FOS transaction. It is null if non XA runtime environment.
Throws:
FosException

isActive

public boolean isActive()
Specifies if this FOS transaction is active or not. true means that it has begun but it has not been committed or rollbacked yet.


prepare

public boolean prepare()
                throws FosException
Prepares a FOS transaction for commit.

Returns:
true if all objects used by this transaction was just read.
Throws:
FosException

commit

public void commit()
            throws FosException
Commits a FOS transaction.

Throws:
FosException

rollback

public void rollback()
              throws FosException
Roolbacks a FOS transaction.

Throws:
FosException


Copyright © 2000-2002 France Telecom S.A., INRIA, IMAG-LSR All Rights Reserved.