Interface OfferCreate
- All Superinterfaces:
Transaction
- All Known Implementing Classes:
ImmutableOfferCreate
An OfferCreate transaction is effectively a limit order. It defines an intent to exchange currencies, and creates an
offer object if not completely fulfilled when placed. Offers can be partially fulfilled.
- See Also:
-
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionstatic ImmutableOfferCreate.Builderbuilder()Construct a builder for this class.default voidcheck()Validates tfHybrid flag cannot be set if the offer doesn't have a DomainID.domainId()The permissioned domain that the offer must be a part of.Optional<com.google.common.primitives.UnsignedInteger> Time after which the Check is no longer valid, in seconds since the Ripple Epoch.default OfferCreateFlagsflags()Set ofOfferCreateFlagss for thisOfferCreate.Optional<com.google.common.primitives.UnsignedInteger> An offer to delete first, specified in the same way as an Offer Cancel.The amount and type of currency being provided by the offer creator.The amount and type of currency being requested by the offer creator.Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
account, accountTransactionId, delegate, fee, lastLedgerSequence, memos, networkId, sequence, signers, signingPublicKey, sourceTag, ticketSequence, transactionFlags, transactionSignature, transactionType, unknownFields, validateDelegateNotSameAsAccount
-
Method Details
-
builder
Construct a builder for this class.- Returns:
- An
ImmutableOfferCreate.Builder.
-
flags
Set ofOfferCreateFlagss for thisOfferCreate.- Returns:
- The
OfferCreateFlagsfor this transaction.
-
offerSequence
Optional<com.google.common.primitives.UnsignedInteger> offerSequence()An offer to delete first, specified in the same way as an Offer Cancel.- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the offer sequence.
-
takerPays
CurrencyAmount takerPays()The amount and type of currency being requested by the offer creator.- Returns:
- A
CurrencyAmountrepresenting the amount being requested.
-
takerGets
CurrencyAmount takerGets()The amount and type of currency being provided by the offer creator.- Returns:
- A
CurrencyAmountrepresenting the amount being offered.
-
expiration
Optional<com.google.common.primitives.UnsignedInteger> expiration()Time after which the Check is no longer valid, in seconds since the Ripple Epoch.- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the expiration time.
-
domainId
The permissioned domain that the offer must be a part of.- Returns:
- A
Hash256representing DomainID.
-
check
@Check default void check()Validates tfHybrid flag cannot be set if the offer doesn't have a DomainID.
-