Interface CheckObject

All Superinterfaces:
LedgerObject
All Known Implementing Classes:
ImmutableCheckObject

@Immutable public interface CheckObject extends LedgerObject
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.)
  • Method Details

    • builder

      static ImmutableCheckObject.Builder builder()
      Construct a builder for this class.
      Returns:
      An ImmutableCheckObject.Builder.
    • ledgerEntryType

      @Derived default LedgerObject.LedgerEntryType ledgerEntryType()
      The value 0x0043, mapped to the string "Check", indicates that this object is a CheckObject object.
      Returns:
      Always LedgerObject.LedgerEntryType.CHECK.
    • account

      Address account()
      The sender of the CheckObject. Cashing the CheckObject debits this address's balance.
      Returns:
      The Address of the sender.
    • sourceTag

      Optional<com.google.common.primitives.UnsignedInteger> sourceTag()
      An arbitrary tag to further specify the source for this CheckObject, such as a hosted recipient at the sender's address.
      Returns:
      An Optional of type UnsignedInteger.
    • destination

      Address destination()
      The intended recipient of the CheckObject. Only this address can cash the CheckObject, using a CheckCash transaction.
      Returns:
      The Address of the destination.
    • destinationTag

      Optional<com.google.common.primitives.UnsignedInteger> destinationTag()
      An arbitrary tag to further specify the destination for this CheckObject, such as a hosted recipient at the destination address.
      Returns:
      An Optional of type UnsignedInteger.
    • flags

      @Derived default Flags flags()
      A bit-map of boolean flags. No flags are defined for CheckObject, 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 String containing the owner node hint.
    • previousTxnId

      Hash256 previousTxnId()
      The identifying hash of the transaction that most recently modified this object.
      Returns:
      A Hash256 containing 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 UnsignedInteger representing the previous transaction sequence.
    • sendMax

      CurrencyAmount sendMax()
      The maximum amount of currency this CheckObject can debit the account(). If the CheckObject is successfully cashed, the destination() 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 the CheckCreate transaction that created this check.
      Returns:
      An UnsignedInteger.
    • destinationNode

      Optional<String> destinationNode()
      A hint indicating which page of the destination()'s owner directory links to this object, in case the directory consists of multiple pages.
      Returns:
      An Optional of type String.
    • 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 Optional of type UnsignedInteger.
    • invoiceId

      Optional<Hash256> invoiceId()
      Arbitrary 256-bit hash provided by the account() as a specific reason or identifier for this CheckObject.
      Returns:
      An Optional of type Hash256.
    • index

      Hash256 index()
      The unique ID of the CheckObject.
      Returns:
      A Hash256.