Package org.xrpl.xrpl4j.model.ledger
Interface CheckObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableCheckObject
A Check object describes a check, similar to a paper personal check, which can be cashed by its destination to
get money from its sender. (The potential payment has already been approved by its sender, but no money moves
until it is cashed. Unlike an Escrow, the money for a Check is not set aside, so cashing the Check could
fail due to lack of funds.)
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()The sender of theCheckObject.static ImmutableCheckObject.Builderbuilder()Construct a builder for this class.The intended recipient of theCheckObject.A hint indicating which page of thedestination()'s owner directory links to this object, in case the directory consists of multiple pages.Optional<com.google.common.primitives.UnsignedInteger> An arbitrary tag to further specify the destination for thisCheckObject, such as a hosted recipient at the destination address.Optional<com.google.common.primitives.UnsignedInteger> Indicates the time after which this Check is considered expired, in seconds since the Ripple Epoch.default Flagsflags()A bit-map of boolean flags.index()The unique ID of theCheckObject.Arbitrary 256-bit hash provided by theaccount()as a specific reason or identifier for thisCheckObject.default LedgerObject.LedgerEntryTypeThe value 0x0043, mapped to the string "Check", indicates that this object is aCheckObjectobject.A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.The identifying hash of the transaction that most recently modified this object.sendMax()The maximum amount of currency thisCheckObjectcan debit theaccount().com.google.common.primitives.UnsignedIntegersequence()The sequence number of theCheckCreatetransaction that created this check.Optional<com.google.common.primitives.UnsignedInteger> An arbitrary tag to further specify the source for thisCheckObject, such as a hosted recipient at the sender's address.
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableCheckObject.Builder.
-
ledgerEntryType
The value 0x0043, mapped to the string "Check", indicates that this object is aCheckObjectobject.- Returns:
- Always
LedgerObject.LedgerEntryType.CHECK.
-
account
Address account()The sender of theCheckObject. Cashing theCheckObjectdebits this address's balance.- Returns:
- The
Addressof the sender.
-
sourceTag
Optional<com.google.common.primitives.UnsignedInteger> sourceTag()An arbitrary tag to further specify the source for thisCheckObject, such as a hosted recipient at the sender's address.- Returns:
- An
Optionalof typeUnsignedInteger.
-
destination
Address destination()The intended recipient of theCheckObject. Only this address can cash theCheckObject, using aCheckCashtransaction.- Returns:
- The
Addressof the destination.
-
destinationTag
Optional<com.google.common.primitives.UnsignedInteger> destinationTag()An arbitrary tag to further specify the destination for thisCheckObject, such as a hosted recipient at the destination address.- Returns:
- An
Optionalof typeUnsignedInteger.
-
flags
A bit-map of boolean flags. No flags are defined forCheckObject, so this value is always 0.- Returns:
- Always
Flags.UNSET.
-
ownerNode
String ownerNode()A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages. Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.- Returns:
- A
Stringcontaining the owner node hint.
-
previousTxnId
Hash256 previousTxnId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing the previous transaction hash.
-
previousTransactionLedgerSequence
com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()The index of the ledger that contains the transaction that most recently modified this object.- Returns:
- A
UnsignedIntegerrepresenting the previous transaction sequence.
-
sendMax
CurrencyAmount sendMax()The maximum amount of currency thisCheckObjectcan debit theaccount(). If theCheckObjectis successfully cashed, thedestination()is credited in the same currency for up to this amount.- Returns:
- A
CurrencyAmount.
-
sequence
com.google.common.primitives.UnsignedInteger sequence()The sequence number of theCheckCreatetransaction that created this check.- Returns:
- An
UnsignedInteger.
-
destinationNode
A hint indicating which page of thedestination()'s owner directory links to this object, in case the directory consists of multiple pages. -
expiration
Optional<com.google.common.primitives.UnsignedInteger> expiration()Indicates the time after which this Check is considered expired, in seconds since the Ripple Epoch.- Returns:
- An
Optionalof typeUnsignedInteger.
-
invoiceId
Arbitrary 256-bit hash provided by theaccount()as a specific reason or identifier for thisCheckObject. -
index
Hash256 index()The unique ID of theCheckObject.- Returns:
- A
Hash256.
-