com.beowulfchain.beowulfj.base.models

Class Transaction

java.lang.Object

com.beowulfchain.beowulfj.base.models.Transaction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SignedTransaction

public class Transaction
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	createdTime
protected TimePointSec	expirationDate
protected List<FutureExtensions>	extensions
protected List<Operation>	operations
protected org.joou.UShort	refBlockNum The ref_block_num indicates a particular block in the past by referring to the block number which has this number as the last two bytes.
protected org.joou.UInteger	refBlockPrefix The ref_block_prefix on the other hand is obtain from the block id of that particular reference block.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Transaction() This method is only used by JUnit-Tests
	Transaction(BlockId blockId, List<Operation> operations, List<FutureExtensions> extensions) Like Transaction(BlockId, List, List) , but allows you to provide a BlockId object as the reference block and will also set the expirationDate to the latest possible time.
	Transaction(org.joou.UShort refBlockNum, org.joou.UInteger refBlockPrefix, TimePointSec expirationDate, List<Operation> operations, List<FutureExtensions> extensions, Long createdTime) Create a new transaction object.

Method Summary

Modifier and Type	Method and Description
Long	getCreatedTime()
TimePointSec	getExpirationDate() Get the currently configured expiration date.
List<FutureExtensions>	getExtensions() Get the list of configured extensions.
List<Operation>	getOperations() Get all Operations that have been added to this transaction.
org.joou.UShort	getRefBlockNum() Get the ref block number in its int representation.
org.joou.UInteger	getRefBlockPrefix() Get the ref block prefix in its long representation.
protected Map<SignatureObject,PrivateKeyType>	getRequiredAuthorities() This method collects the required authorities for all operations stored in this transaction.
void	setCreatedTime(Long createdTime)
void	setExpirationDate(TimePointSec expirationDate) Define how long this transaction is valid.
void	setExtensions(List<FutureExtensions> extensions) Extensions are currently not supported and will be ignored.
void	setOperations(List<Operation> operations) Define a list of operations that should be send with this transaction.
void	setRefBlockNum(org.joou.UShort refBlockNum) Set the ref block number by providing its int representation.
void	setRefBlockPrefix(String refBlockPrefix) Set the ref block prefix by providing its String representation.
void	setRefBlockPrefix(org.joou.UInteger refBlockPrefix) Set the ref block prefix by providing its long representation.
String	toString()
void	validate() Validate if all fields of this transaction object have acceptable values.

Methods inherited from class java.lang.Object

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

Field Detail

refBlockNum

protected org.joou.UShort refBlockNum

The ref_block_num indicates a particular block in the past by referring to the block number which has this number as the last two bytes.

refBlockPrefix

protected org.joou.UInteger refBlockPrefix

The ref_block_prefix on the other hand is obtain from the block id of that particular reference block.

expirationDate

protected transient TimePointSec expirationDate

operations

protected transient List<Operation> operations

extensions

protected transient List<FutureExtensions> extensions

createdTime

protected Long createdTime

Constructor Detail

Transaction

public Transaction(org.joou.UShort refBlockNum,
                   org.joou.UInteger refBlockPrefix,
                   TimePointSec expirationDate,
                   List<Operation> operations,
                   List<FutureExtensions> extensions,
                   Long createdTime)

Create a new transaction object.

Parameters:

refBlockNum - The reference block number (see setRefBlockNum(UShort)).

refBlockPrefix - The reference block index (see setRefBlockPrefix(UInteger)).

expirationDate - Define until when the transaction has to be processed (see setExpirationDate(TimePointSec)).

operations - A list of operations to process within this Transaction (see setOperations(List)).

extensions - Extensions are currently not supported and will be ignored (see setExtensions(List)).

createdTime - Timestamp create transaction.

Transaction

public Transaction(BlockId blockId,
                   List<Operation> operations,
                   List<FutureExtensions> extensions)

Like Transaction(BlockId, List, List) , but allows you to provide a BlockId object as the reference block and will also set the expirationDate to the latest possible time.

Parameters:

blockId - The block reference (see setRefBlockNum(UShort) and setRefBlockPrefix(UInteger)).

operations - A list of operations to process within this Transaction (see setOperations(List)).

extensions - Extensions are currently not supported and will be ignored (see setExtensions(List)).

Transaction

protected Transaction()

This method is only used by JUnit-Tests

Create a new signed transaction object.

Method Detail

getExtensions

public List<FutureExtensions> getExtensions()

Get the list of configured extensions.

Returns:

All extensions.

setExtensions

public void setExtensions(List<FutureExtensions> extensions)

Extensions are currently not supported and will be ignored.

Parameters:

extensions - Define a list of extensions.

getOperations

public List<Operation> getOperations()

Get all Operations that have been added to this transaction.

Returns:

All operations.

setOperations

public void setOperations(List<Operation> operations)

Define a list of operations that should be send with this transaction.

Parameters:

operations - A list of operations.

Throws:

InvalidParameterException - If the given object does not contain at least one Operation.

getRefBlockNum

public org.joou.UShort getRefBlockNum()

Get the ref block number in its int representation.

The ref_block_num indicates a particular block in the past by referring to the block number which has this number as the last two bytes.

Returns:

The ref block number.

setRefBlockNum

public void setRefBlockNum(org.joou.UShort refBlockNum)

Set the ref block number by providing its int representation.

The ref_block_num indicates a particular block in the past by referring to the block number which has this number as the last two bytes.

Parameters:

refBlockNum - The ref block number as int.

getRefBlockPrefix

public org.joou.UInteger getRefBlockPrefix()

Get the ref block prefix in its long representation.

The ref_block_prefix on the other hand is obtain from the block id of that particular reference block.

Returns:

The ref block prefix.

setRefBlockPrefix

public void setRefBlockPrefix(org.joou.UInteger refBlockPrefix)

Set the ref block prefix by providing its long representation. If you only have the String representation use setRefBlockPrefix(String).

Parameters:

refBlockPrefix - The ref block prefix.

setRefBlockPrefix

public void setRefBlockPrefix(String refBlockPrefix)

Set the ref block prefix by providing its String representation. The String representation can be received from the @link getDynamicGlobalProperties method.

Parameters:

refBlockPrefix - The String representation of the ref block prefix.

getExpirationDate

public TimePointSec getExpirationDate()

Get the currently configured expiration date. The expiration date defines in which time the operation has to be processed. If not processed in the given time, the transaction will not be accepted. Notice that this method will return the latest possible expiration date if no other time has been configured using the setExpirationDate(TimePointSec) method.

Returns:

The expiration date.

setExpirationDate

public void setExpirationDate(TimePointSec expirationDate)

Define how long this transaction is valid. If not processed in the given time, the transaction will not be accepted.

Parameters:

expirationDate - The expiration date to set.

getRequiredAuthorities

protected Map<SignatureObject,PrivateKeyType> getRequiredAuthorities()

This method collects the required authorities for all operations stored in this transaction. The returned list is already a minimized version to avoid an "irrelevant signature included Unnecessary signature(s) detected" error.

Returns:

All required authorities and private key types.

getCreatedTime

public Long getCreatedTime()

setCreatedTime

public void setCreatedTime(Long createdTime)

validate

public void validate()
              throws BeowulfInvalidTransactionException

Validate if all fields of this transaction object have acceptable values.

Throws:

BeowulfInvalidTransactionException - In case a field does not fulfill the requirements.

toString

public String toString()

Overrides:

toString in class Object