Transaction (symbol-sdk-java 1.0.1 API)

java.lang.Object
- io.nem.symbol.sdk.model.transaction.Transaction

All Implemented Interfaces:

Stored

Direct Known Subclasses:

AccountAddressRestrictionTransaction, AccountKeyLinkTransaction, AccountMosaicRestrictionTransaction, AccountOperationRestrictionTransaction, AddressAliasTransaction, AggregateTransaction, HashLockTransaction, MetadataTransaction, MosaicAddressRestrictionTransaction, MosaicAliasTransaction, MosaicDefinitionTransaction, MosaicGlobalRestrictionTransaction, MosaicSupplyChangeTransaction, MultisigAccountModificationTransaction, NamespaceRegistrationTransaction, NodeKeyLinkTransaction, SecretLockTransaction, SecretProofTransaction, TransferTransaction, VotingKeyLinkTransaction, VrfKeyLinkTransaction
```
public abstract class Transaction
extends java.lang.Object
implements Stored
```
An abstract transaction class that serves as the base class of all NEM transactions.

Since:

1.0

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`createTransactionHash(java.lang.String transactionPayload, byte[] generationHashBytes)` Generates hash for a serialized transaction payload.
`Deadline`	`getDeadline()` Returns the deadline to include the transaction.
`java.util.Optional<TransactionGroup>`	`getGroup()`
`java.math.BigInteger`	`getMaxFee()` Returns the fee for the transaction.
`NetworkType`	`getNetworkType()` Returns the network type.
`java.util.Optional<java.lang.String>`	`getRecordId()` Returns database record id of the entity.
`java.util.Optional<java.lang.String>`	`getSignature()` Returns the transaction signature (missing if part of an aggregate transaction).
`byte[]`	`getSignBytes(byte[] payloadBytes, byte[] generationHashBytes)` Get the bytes required for signing.
`java.util.Optional<PublicAccount>`	`getSigner()` Returns the transaction creator public account.
`long`	`getSize()` It returns the transaction's byte array size useful to calculate its fee.
`java.util.Optional<TransactionInfo>`	`getTransactionInfo()` Returns meta data object contains additional information about the transaction.
`TransactionType`	`getType()` Returns the transaction type.
`java.lang.Integer`	`getVersion()` Returns the transaction version.
`boolean`	`hasMissingSignatures()` Returns if a transaction has missing signatures.
`boolean`	`isConfirmed()` Return if a transaction is known to be confirmed
`boolean`	`isPartial()` Returns if a transaction is partial waiting for more cosignatures
`boolean`	`isTransactionFullyLoaded()` Returns if the transaction has been fully loaded from rest, if not, the transaction cannot be serialized.
`boolean`	`isUnannounced()` Returns if a transaction is not known by the network.
`boolean`	`isUnconfirmed()` Returns if a transaction is pending to be included in a block.
`byte[]`	`serialize()` Serialises a transaction model into binary (unsigned payload).
`SignedTransaction`	`signWith(Account account, java.lang.String generationHash)` Serialize and sign transaction creating a new SignedTransaction.
`Transaction`	`toAggregate(PublicAccount signer)` Convert an aggregate transaction to an inner transaction including transaction signer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getType
```
public TransactionType getType()
```
    Returns the transaction type.
    
    Returns:
    
    transaction type
  - getNetworkType
```
public NetworkType getNetworkType()
```
    Returns the network type.
    
    Returns:
    
    the network type
  - getVersion
```
public java.lang.Integer getVersion()
```
    Returns the transaction version.
    
    Returns:
    
    transaction version
  - getDeadline
```
public Deadline getDeadline()
```
    Returns the deadline to include the transaction.
    
    Returns:
    
    deadline to include transaction into a block.
  - getMaxFee
```
public java.math.BigInteger getMaxFee()
```
    Returns the fee for the transaction. The higher the fee, the higher the priority of the transaction. Transactions with high priority get included in a block before transactions with lower priority.
    
    Returns:
    
    fee amount
  - getSignature
```
public java.util.Optional<java.lang.String> getSignature()
```
    Returns the transaction signature (missing if part of an aggregate transaction).
    
    Returns:
    
    transaction signature
  - getSigner
```
public java.util.Optional<PublicAccount> getSigner()
```
    Returns the transaction creator public account.
    
    Returns:
    
    signer public account
  - getTransactionInfo
```
public java.util.Optional<TransactionInfo> getTransactionInfo()
```
    Returns meta data object contains additional information about the transaction.
    
    Returns:
    
    transaction meta data info.
  - serialize
```
public byte[] serialize()
```
    Serialises a transaction model into binary (unsigned payload). Gets the serialised bytes for a transaction.
    
    Returns:
    
    bytes of the transaction
  - getSize
```
public long getSize()
```
    It returns the transaction's byte array size useful to calculate its fee.
    
    Returns:
    
    the size of the transaction.
  - createTransactionHash
```
public java.lang.String createTransactionHash(java.lang.String transactionPayload,
                                              byte[] generationHashBytes)
```
    Generates hash for a serialized transaction payload.
    
    Parameters:
    
    transactionPayload - Transaction payload
    
    generationHashBytes - the generation hash.
    
    Returns:
    
    generated transaction hash.
  - getSignBytes
```
public byte[] getSignBytes(byte[] payloadBytes,
                           byte[] generationHashBytes)
```
    Get the bytes required for signing.
    
    Parameters:
    
    payloadBytes - Payload bytes.
    
    generationHashBytes - Generation hash bytes.
    
    Returns:
    
    Bytes to sign.
  - signWith
```
public SignedTransaction signWith(Account account,
                                  java.lang.String generationHash)
```
    Serialize and sign transaction creating a new SignedTransaction.
    
    Parameters:
    
    account - The account to sign the transaction.
    
    generationHash - The generation hash for the network.
    
    Returns:
    
    SignedTransaction
  - toAggregate
```
public Transaction toAggregate(PublicAccount signer)
```
    Convert an aggregate transaction to an inner transaction including transaction signer.
    
    Parameters:
    
    signer - Transaction signer.
    
    Returns:
    
    instance of Transaction with signer
  - isUnconfirmed
```
public boolean isUnconfirmed()
```
    Returns if a transaction is pending to be included in a block.
    
    Returns:
    
    if a transaction is pending to be included in a block
  - isPartial
```
public boolean isPartial()
```
    Returns if a transaction is partial waiting for more cosignatures
    
    Returns:
    
    if a transaction is partial waiting for more cosignatures
  - hasMissingSignatures
```
public boolean hasMissingSignatures()
```
    Returns if a transaction has missing signatures.
    
    Returns:
    
    if a transaction has missing signatures
  - isUnannounced
```
public boolean isUnannounced()
```
    Returns if a transaction is not known by the network.
    
    Returns:
    
    if a transaction is not known by the network
  - isConfirmed
```
public boolean isConfirmed()
```
    Return if a transaction is known to be confirmed
    
    Returns:
    
    if a transaction is known to be confirmed
  - getGroup
```
public java.util.Optional<TransactionGroup> getGroup()
```
    Returns:
    
    the group of the transaction if known.
  - isTransactionFullyLoaded
```
public boolean isTransactionFullyLoaded()
```
    Returns if the transaction has been fully loaded from rest, if not, the transaction cannot be serialized.
    
    Returns:
    
    if the transaction has been fully loaded from rest.
  - getRecordId
```
public java.util.Optional<java.lang.String> getRecordId()
```
    Description copied from interface: Stored
    
    Returns database record id of the entity.
    
    Specified by:
    
    getRecordId in interface Stored
    
    Returns:
    
    the database id if known.

Class Transaction

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getType

getNetworkType

getVersion

getDeadline

getMaxFee

getSignature

getSigner

getTransactionInfo

serialize

getSize

createTransactionHash

getSignBytes

signWith

toAggregate

isUnconfirmed

isPartial

hasMissingSignatures

isUnannounced

isConfirmed

getGroup

isTransactionFullyLoaded

getRecordId