Package org.xmldb.api.sdk.modules

Class SimpleTransactionService

java.lang.Object

org.xmldb.api.sdk.SimpleConfigurable

org.xmldb.api.sdk.modules.SimpleTransactionService

All Implemented Interfaces:

Configurable, Service, TransactionService

public class SimpleTransactionService
extends SimpleConfigurable
implements TransactionService

Provides the ability to bundle Collection operations into a transaction.

Note: This interface needs much better definition

Field Summary

Fields inherited from interface org.xmldb.api.modules.TransactionService

SERVICE_NAME

Constructor Summary

Constructors

Constructor	Description
SimpleTransactionService()

Method Summary

Modifier and Type	Method	Description
void	begin()	Begin the transaction
void	commit()	Commit the transaction
String	getName()	Returns the name associated with the Configurable object.
String	getVersion()	Gets the Version attribute of the Service object
void	rollback()	Rollback the transaction
void	setCollection(Collection col)	Sets the Collection attribute of the Service object

Methods inherited from class org.xmldb.api.sdk.SimpleConfigurable

getProperty, setProperty

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.xmldb.api.base.Configurable

getProperty, setProperty

Constructor Details

SimpleTransactionService

public SimpleTransactionService()

Method Details

getName

public String getName()
               throws XMLDBException

Returns the name associated with the Configurable object.

Specified by:

getName in interface Service

Returns:

the name of the object.

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getVersion

public String getVersion()
                  throws XMLDBException

Gets the Version attribute of the Service object

Specified by:

getVersion in interface Service

Returns:

The Version value

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

setCollection

public void setCollection(Collection col)
                   throws XMLDBException

Sets the Collection attribute of the Service object

Specified by:

setCollection in interface Service

Parameters:

col - The new Collection value

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

begin

public void begin()
           throws XMLDBException

Begin the transaction

Specified by:

begin in interface TransactionService

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

commit

public void commit()
            throws XMLDBException

Commit the transaction

Specified by:

commit in interface TransactionService

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

rollback

public void rollback()
              throws XMLDBException

Rollback the transaction

Specified by:

rollback in interface TransactionService

Throws:

XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.