Builder for Offer ledger entries. More...

#include <Offer.h>

Inheritance diagram for xrpl::ledger_entries::OfferBuilder:

Collaboration diagram for xrpl::ledger_entries::OfferBuilder:

[legend]

Public Member Functions
	OfferBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &account, std::decay_t< typename SF_UINT32::type::value_type > const &sequence, std::decay_t< typename SF_AMOUNT::type::value_type > const &takerPays, std::decay_t< typename SF_AMOUNT::type::value_type > const &takerGets, std::decay_t< typename SF_UINT256::type::value_type > const &bookDirectory, std::decay_t< typename SF_UINT64::type::value_type > const &bookNode, std::decay_t< typename SF_UINT64::type::value_type > const &ownerNode, std::decay_t< typename SF_UINT256::type::value_type > const &previousTxnID, std::decay_t< typename SF_UINT32::type::value_type > const &previousTxnLgrSeq)
	Construct a new OfferBuilder with required fields.

	OfferBuilder (std::shared_ptr< SLE const > sle)
	Construct a OfferBuilder from an existing SLE object.

OfferBuilder &	setAccount (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.

OfferBuilder &	setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSequence (soeREQUIRED)

OfferBuilder &	setTakerPays (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfTakerPays (soeREQUIRED)

OfferBuilder &	setTakerGets (std::decay_t< typename SF_AMOUNT::type::value_type > const &value)
	Set sfTakerGets (soeREQUIRED)

OfferBuilder &	setBookDirectory (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfBookDirectory (soeREQUIRED)

OfferBuilder &	setBookNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfBookNode (soeREQUIRED)

OfferBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)

OfferBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)

OfferBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)

OfferBuilder &	setExpiration (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfExpiration (soeOPTIONAL)

OfferBuilder &	setDomainID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfDomainID (soeOPTIONAL)

OfferBuilder &	setAdditionalBooks (STArray const &value)
	Set sfAdditionalBooks (soeOPTIONAL)

Offer	build (uint256 const &index)
	Build and return the completed Offer wrapper.

bool	validate () const
	Validate the ledger entry.

OfferBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.

OfferBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for Offer ledger entries.

Provides a fluent interface for constructing ledger entries with method chaining. Uses Json::Value internally for flexible ledger entry construction. Inherits common field setters from LedgerEntryBuilderBase.

Definition at line 228 of file protocol_autogen/ledger_entries/Offer.h.

Constructor & Destructor Documentation

◆ OfferBuilder() [1/2]

xrpl::ledger_entries::OfferBuilder::OfferBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	account,
		std::decay_t< typename SF_UINT32::type::value_type > const &	sequence,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	takerPays,
		std::decay_t< typename SF_AMOUNT::type::value_type > const &	takerGets,
		std::decay_t< typename SF_UINT256::type::value_type > const &	bookDirectory,
		std::decay_t< typename SF_UINT64::type::value_type > const &	bookNode,
		std::decay_t< typename SF_UINT64::type::value_type > const &	ownerNode,
		std::decay_t< typename SF_UINT256::type::value_type > const &	previousTxnID,
		std::decay_t< typename SF_UINT32::type::value_type > const &	previousTxnLgrSeq
	)

Construct a new OfferBuilder with required fields.

Parameters

account	The sfAccount field value.
sequence	The sfSequence field value.
takerPays	The sfTakerPays field value.
takerGets	The sfTakerGets field value.
bookDirectory	The sfBookDirectory field value.
bookNode	The sfBookNode field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 243 of file protocol_autogen/ledger_entries/Offer.h.

◆ OfferBuilder() [2/2]

xrpl::ledger_entries::OfferBuilder::OfferBuilder ( std::shared_ptr< SLE const > sle )

Construct a OfferBuilder from an existing SLE object.

Parameters

sle	The existing ledger entry to copy from.

Exceptions

std::runtime_error if the ledger entry type doesn't match.

Definition at line 262 of file protocol_autogen/ledger_entries/Offer.h.

Member Function Documentation

◆ setAccount()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setAccount ( std::decay_t< typename SF_ACCOUNT::type::value_type > const & value )

Ledger entry-specific field setters.

Set sfAccount (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 278 of file protocol_autogen/ledger_entries/Offer.h.

◆ setSequence()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setSequence ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfSequence (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 289 of file protocol_autogen/ledger_entries/Offer.h.

◆ setTakerPays()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setTakerPays ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfTakerPays (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 300 of file protocol_autogen/ledger_entries/Offer.h.

◆ setTakerGets()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setTakerGets ( std::decay_t< typename SF_AMOUNT::type::value_type > const & value )

Set sfTakerGets (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 311 of file protocol_autogen/ledger_entries/Offer.h.

◆ setBookDirectory()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setBookDirectory ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfBookDirectory (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 322 of file protocol_autogen/ledger_entries/Offer.h.

◆ setBookNode()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setBookNode ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfBookNode (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 333 of file protocol_autogen/ledger_entries/Offer.h.

◆ setOwnerNode()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setOwnerNode ( std::decay_t< typename SF_UINT64::type::value_type > const & value )

Set sfOwnerNode (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 344 of file protocol_autogen/ledger_entries/Offer.h.

◆ setPreviousTxnID()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setPreviousTxnID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfPreviousTxnID (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 355 of file protocol_autogen/ledger_entries/Offer.h.

◆ setPreviousTxnLgrSeq()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setPreviousTxnLgrSeq ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfPreviousTxnLgrSeq (soeREQUIRED)

Returns: Reference to this builder for method chaining.

Definition at line 366 of file protocol_autogen/ledger_entries/Offer.h.

◆ setExpiration()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setExpiration ( std::decay_t< typename SF_UINT32::type::value_type > const & value )

Set sfExpiration (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 377 of file protocol_autogen/ledger_entries/Offer.h.

◆ setDomainID()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setDomainID ( std::decay_t< typename SF_UINT256::type::value_type > const & value )

Set sfDomainID (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 388 of file protocol_autogen/ledger_entries/Offer.h.

◆ setAdditionalBooks()

OfferBuilder & xrpl::ledger_entries::OfferBuilder::setAdditionalBooks ( STArray const & value )

Set sfAdditionalBooks (soeOPTIONAL)

Returns: Reference to this builder for method chaining.

Definition at line 399 of file protocol_autogen/ledger_entries/Offer.h.

◆ build()

Offer xrpl::ledger_entries::OfferBuilder::build ( uint256 const & index )

Build and return the completed Offer wrapper.

Parameters

index The ledger entry index.

Returns: The constructed ledger entry wrapper.

Definition at line 411 of file protocol_autogen/ledger_entries/Offer.h.

◆ validate()

bool xrpl::ledger_entries::LedgerEntryBuilderBase< OfferBuilder >::validate ( ) const

inherited

Validate the ledger entry.

Returns: true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

◆ setLedgerIndex()

OfferBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< OfferBuilder >::setLedgerIndex ( uint256 const & value )

inherited

Set the ledger index.

Parameters

value Ledger index

Returns: Reference to the derived builder for method chaining.

Definition at line 62 of file LedgerEntryBuilderBase.h.

◆ setFlags()

OfferBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< OfferBuilder >::setFlags ( uint32_t value )

inherited

Set the flags.

Parameters

value Flags value

Returns: Reference to the derived builder for method chaining.

Definition at line 74 of file LedgerEntryBuilderBase.h.

Member Data Documentation

◆ object_

STObject xrpl::ledger_entries::LedgerEntryBuilderBase< OfferBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ OfferBuilder() [1/2]

◆ OfferBuilder() [2/2]

Member Function Documentation

◆ setAccount()

◆ setSequence()

◆ setTakerPays()

◆ setTakerGets()

◆ setBookDirectory()

◆ setBookNode()

◆ setOwnerNode()

◆ setPreviousTxnID()

◆ setPreviousTxnLgrSeq()

◆ setExpiration()

◆ setDomainID()

◆ setAdditionalBooks()

◆ build()

◆ validate()

◆ setLedgerIndex()

◆ setFlags()

Member Data Documentation

◆ object_