com.aspc.DBObj.Archive

Class TransGroup

java.lang.Object

com.aspc.DBObj.Archive.TransGroup

public final class TransGroup
extends java.lang.Object

Transaction Group The transaction group allows a series of transaction to be treated as group The system lends itself to better performance when changes are applied in smaller batches as less overhead is needed in maintaining the universe. With this in mind the transaction group allows all the transactions for a process to be referenced so that they can be easily reversed if need be.
THREAD MODE: MULTI-THREADED

Since:

May 17, 2005, 13:30 PM

Author:

Jason McGrath

Constructor Summary

Constructors

Constructor and Description
TransGroup(VirtualDB vDB, long transGroupId, java.lang.String reason)

Method Summary

Modifier and Type	Method and Description
static TransGroup	build(VirtualDB vDB, java.lang.String groupCode, java.lang.String reason) Constructs a new Transaction Group with the supplied groupCode and reason.
static TransGroup	find(VirtualDB vDB, long transGroupId) Searches for a TransGroup that matches the transaction group id.
VirtualDB	getDatabase() Returns the VirtualDB that this transaction group was loaded from
java.lang.String	getKey()
java.lang.String	getReason() Returns the reason value that was saved with this transaction group
long	getTransGroupId() returns the transaction id for this transaction header.
static TransGroup[]	list(VirtualDB vDB, java.lang.String groupCode) Searches for a TransGroup that matches the group code.
TransHeader[]	listTransHeaders() Retrieve a list of transaction headers that are related to this group
long	reverse(Login login) Reverses all transactions in group
long	reverse(Login login, boolean replayMode) Reverses all transactions in group
void	reverse(MutableDataSource mds, boolean replayMode) Reverses all transactions in group using supplied data source

Methods inherited from class java.lang.Object

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

Constructor Detail

TransGroup

public TransGroup(@Nonnull
                  VirtualDB vDB,
                  long transGroupId,
                  @Nonnull
                  java.lang.String reason)

Parameters:

vDB - the layer

transGroupId - the transaction group

reason - the reason

Method Detail

build

@Nonnull
public static TransGroup build(@Nonnull
                                        VirtualDB vDB,
                                        @Nonnull
                                        java.lang.String groupCode,
                                        @Nonnull
                                        java.lang.String reason)
                                 throws java.lang.Exception

Constructs a new Transaction Group with the supplied groupCode and reason. The groupCode and reason are optional.

Parameters:

vDB - VirtualDB that this transaction group will be saved to

groupCode - Code to be set on the group

reason - Optional reason for future reference

Returns:

Returns the new TransGroup object

Throws:

java.lang.Exception - Serious error

find

@CheckReturnValue
 @Nonnull
public static TransGroup find(@Nonnull
                                                          VirtualDB vDB,
                                                          long transGroupId)
                                                   throws NotFoundException

Searches for a TransGroup that matches the transaction group id.

Parameters:

vDB - VirtualDb that contains group.

transGroupId - Group id

Returns:

Returns the TransGroup object which matches the supplied group id.

Throws:

NotFoundException - The TransGroup entry could not be found

list

@CheckReturnValue
 @Nonnull
public static TransGroup[] list(@Nonnull
                                                            VirtualDB vDB,
                                                            @Nonnull
                                                            java.lang.String groupCode)

Searches for a TransGroup that matches the group code.

Parameters:

vDB - VirtualDb that contains group.

groupCode - Group code

Returns:

Returns the TransGroup object which matches the supplied group code.

reverse

public long reverse(@Nonnull
                    Login login)
             throws java.lang.Exception

Reverses all transactions in group

Parameters:

login - The login to be used when creating the new mutable data source.

Returns:

The id of the transaction used to save reversals

Throws:

java.lang.Exception - Transactions could not be reversed

reverse

public long reverse(@Nonnull
                    Login login,
                    boolean replayMode)
             throws java.lang.Exception

Reverses all transactions in group

Parameters:

login - The login to be used when creating the new mutable data source.

replayMode - Reverse only if safe to do so.

Returns:

The id of the transaction used to save reversals

Throws:

java.lang.Exception - Transactions could not be reversed

reverse

public void reverse(@Nonnull
                    MutableDataSource mds,
                    boolean replayMode)
             throws java.lang.Exception

Reverses all transactions in group using supplied data source

Parameters:

mds - Mutable data source to be used

replayMode - Reverse only if safe to do so.

Throws:

java.lang.Exception - Transactions could not be reversed

listTransHeaders

@CheckReturnValue
 @Nonnull
public TransHeader[] listTransHeaders()

Retrieve a list of transaction headers that are related to this group

Returns:

Returns a list of transaction headers.

getDatabase

@CheckReturnValue
 @Nonnull
public VirtualDB getDatabase()

Returns the VirtualDB that this transaction group was loaded from

Returns:

Returns the VirtualDB

getTransGroupId

@CheckReturnValue
public long getTransGroupId()

returns the transaction id for this transaction header.

Returns:

The transaction id

getReason

@CheckReturnValue
 @Nonnull
public java.lang.String getReason()

Returns the reason value that was saved with this transaction group

Returns:

Reason

getKey

@CheckReturnValue
 @Nonnull
public java.lang.String getKey()

Returns:

the key