Package com.storedobject.core

Class TransactionInformation

java.lang.Object

com.storedobject.core.TransactionInformation

public final class TransactionInformation
extends Object

A structure that encapsulates all the objects (including links) involved in a transaction. get(BigInteger) method is used to create a TransactionInformation structure populated with all involved objects.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	TransactionInformation.TransactionLink<L extends StoredObject>	Class that encapsulates a link involved in a transaction.
final class	TransactionInformation.TransactionObject<T extends StoredObject>	Class that encapsulates an object involved in the transaction.

Method Summary

Modifier and Type	Method	Description
void	dump(StringBuilder s)	Dump the object and link details to a "String Builder".
static TransactionInformation	get(BigInteger transactionId)	Get the TransactionInformation.TransactionLink for a particular transaction.
TransactionInformation.TransactionObject<?>	getObject(Id id)	Get the involved object for the given Id.
<O extends StoredObject> TransactionInformation.TransactionObject<O>	getObject(O object)	Get the involved object for the given object.
Timestamp	getTimestamp()	Get the timestamp of this transaction.
BigInteger	getTransactionId()	Get the transaction Id.
SystemUser	getUser()	Get the user who created this transaction.
Id	getUserId()	Get the user's Id who created this transaction.
boolean	inProgress()	Check whether this transaction is in progress or not.
boolean	isAbandoned()	Check whether this is an abandoned transaction or not.
Stream<TransactionInformation.TransactionObject<?>>	objects()	Get the objects involved in this transaction.
<O extends StoredObject> Stream<TransactionInformation.TransactionObject<O>>	objects(Class<O> objectClass, boolean any)	Get a particular type of objects involved in this transaction.

Methods inherited from class java.lang.Object

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

Method Details

get

public static TransactionInformation get(BigInteger transactionId)

Get the TransactionInformation.TransactionLink for a particular transaction.

Parameters:

transactionId - Transaction Id

Returns:

The Transaction Link if available, otherwise null is returned.

getTransactionId

public BigInteger getTransactionId()

Get the transaction Id.

Returns:

Transaction Id.

getTimestamp

public Timestamp getTimestamp()

Get the timestamp of this transaction.

Returns:

Transaction timestamp.

getUser

public SystemUser getUser()

Get the user who created this transaction.

Returns:

User. (This will return null if the transaction was aborted by the system).

getUserId

public Id getUserId()

Get the user's Id who created this transaction.

Returns:

Id of the user.

isAbandoned

public boolean isAbandoned()

Check whether this is an abandoned transaction or not.

Returns:

True or false.

inProgress

public boolean inProgress()

Check whether this transaction is in progress or not.

Returns:

True or false.

objects

public Stream<TransactionInformation.TransactionObject<?>> objects()

Get the objects involved in this transaction.

Returns:

Stream of TransactionInformation.TransactionObjects.

objects

public <O extends StoredObject>
Stream<TransactionInformation.TransactionObject<O>> objects(Class<O> objectClass,
 boolean any)

Get a particular type of objects involved in this transaction.

Type Parameters:

O - Type of objects to return

Parameters:

objectClass - Call type

any - Whether to return inherited types of not

Returns:

Stream of TransactionInformation.TransactionObjects.

getObject

public TransactionInformation.TransactionObject<?> getObject(Id id)

Get the involved object for the given Id.

Parameters:

id - Id of the object

Returns:

Transaction object for the Id passed.

getObject

public <O extends StoredObject>
TransactionInformation.TransactionObject<O> getObject(O object)

Get the involved object for the given object.

Type Parameters:

O - Type of the object

Parameters:

object - Object for which involved object to be retrieved

Returns:

Transaction object for the object passed.

dump

public void dump(StringBuilder s)

Dump the object and link details to a "String Builder".

Parameters:

s - "String Builder" to which output should be written.