com.sapportals.wcm.repository.txn

Interface IFrameworkTransaction

public interface IFrameworkTransaction

Interface for framework wide transactions.

Copyright (c) SAP AG 2004

Method Summary

void	addEndListener(ITransactionEndsListener listener) Adds an ITransactionEndsListener which is called either when the transaction is committed or rollbacked.
void	addTransactionObject(Object key, Object o) Stores all kind of objects in this framework transaction.
boolean	commit() Has be called when a a transaction shall be committed.
Connection	getConnection() Returns a valid connection object.
ITransactionEndsListener	getEndListener(String key) Returns a specific listener if it is already registered with this transaction
Object	getTransactionObject(Object key) Returns a previous added object.
boolean	isActive()
boolean	isEndListenerRegistered(ITransactionEndsListener listener) Tells if a specific listener is already registered with this transaction
void	rollback() Has be called when a a transaction shall be rollbacked.
void	setVeto() If called a later commit will always return with false and a rollback will be performed.
void	setVeto(Exception cause) If called a later commit will always return with false and a rollback will be performed.
boolean	willBeRollbacked() Check whether it is necessary to perform further actions with this open transaction.

Method Detail

getConnection

public Connection getConnection()
                         throws TxException

Returns a valid connection object.
You must not call Connection.commit() or Connection.rollback() on this connection. Instead just close it and call commit() or rollback() on this transaction object afterwards.

Returns:

the connection to be used for all persistence calls

Throws:

TxException

addTransactionObject

public void addTransactionObject(Object key,
                                 Object o)

Stores all kind of objects in this framework transaction. Can be retrieved via getTransactionObject(java.lang.Object)

getTransactionObject

public Object getTransactionObject(Object key)

Returns a previous added object.

Parameters:

key - the lookup key

Returns:

null or the previously added object

See Also:

addTransactionObject(Object, Object)

addEndListener

public void addEndListener(ITransactionEndsListener listener)
                    throws TxException

Adds an ITransactionEndsListener which is called either when the transaction is committed or rollbacked.

Parameters:

listener -

Throws:

TxException

isEndListenerRegistered

public boolean isEndListenerRegistered(ITransactionEndsListener listener)
                                throws TxException

Tells if a specific listener is already registered with this transaction

Parameters:

listener -

Throws:

TxException

getEndListener

public ITransactionEndsListener getEndListener(String key)
                                        throws TxException

Returns a specific listener if it is already registered with this transaction

Parameters:

key -

Throws:

TxException

commit

public boolean commit()
               throws TxException

Has be called when a a transaction shall be committed. All notifiers will be called and the connection closed. If transaction can not be committed an implicit rollback() will be called and false returned.

Returns:

true if commit was performed, false otherwise

Throws:

TxException - if the commit failed, a veto was given or this transaction is not active.

rollback

public void rollback()
              throws TxException

Has be called when a a transaction shall be rollbacked. All notifiers will be called and the connection closed.

Throws:

TxException - if this transaction is not active.

See Also:

willBeRollbacked()

setVeto

public void setVeto()
             throws TxException

If called a later commit will always return with false and a rollback will be performed.

Throws:

TxException

See Also:

willBeRollbacked()

setVeto

public void setVeto(Exception cause)
             throws TxException

If called a later commit will always return with false and a rollback will be performed.

Parameters:

cause - A root exception as reason why the transaction is to be rolled back.

Throws:

TxException

See Also:

willBeRollbacked()

willBeRollbacked

public boolean willBeRollbacked()
                         throws TxException

Check whether it is necessary to perform further actions with this open transaction.

Returns:

true if a setVeto() was called.

Throws:

TxException

isActive

public boolean isActive()
                 throws TxException

Returns:

true, if this transaction was committed or rolled back. false, otherwise.

Throws:

TxException