xrpl::ledger_entries::PermissionedDomainBuilder Class Reference

Builder for PermissionedDomain ledger entries. More...

#include <PermissionedDomain.h>

Inheritance diagram for xrpl::ledger_entries::PermissionedDomainBuilder:

Collaboration diagram for xrpl::ledger_entries::PermissionedDomainBuilder:

Public Member Functions
	PermissionedDomainBuilder (std::decay_t< typename SF_ACCOUNT::type::value_type > const &owner, std::decay_t< typename SF_UINT32::type::value_type > const &sequence, STArray const &acceptedCredentials, 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 PermissionedDomainBuilder with required fields.
	PermissionedDomainBuilder (std::shared_ptr< SLE const > sle)
	Construct a PermissionedDomainBuilder from an existing SLE object.
PermissionedDomainBuilder &	setOwner (std::decay_t< typename SF_ACCOUNT::type::value_type > const &value)
	Ledger entry-specific field setters.
PermissionedDomainBuilder &	setSequence (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfSequence (soeREQUIRED)
PermissionedDomainBuilder &	setAcceptedCredentials (STArray const &value)
	Set sfAcceptedCredentials (soeREQUIRED)
PermissionedDomainBuilder &	setOwnerNode (std::decay_t< typename SF_UINT64::type::value_type > const &value)
	Set sfOwnerNode (soeREQUIRED)
PermissionedDomainBuilder &	setPreviousTxnID (std::decay_t< typename SF_UINT256::type::value_type > const &value)
	Set sfPreviousTxnID (soeREQUIRED)
PermissionedDomainBuilder &	setPreviousTxnLgrSeq (std::decay_t< typename SF_UINT32::type::value_type > const &value)
	Set sfPreviousTxnLgrSeq (soeREQUIRED)
PermissionedDomain	build (uint256 const &index)
	Build and return the completed PermissionedDomain wrapper.
bool	validate () const
	Validate the ledger entry.
PermissionedDomainBuilder &	setLedgerIndex (uint256 const &value)
	Set the ledger index.
PermissionedDomainBuilder &	setFlags (uint32_t value)
	Set the flags.

Protected Attributes
STObject	object_

Detailed Description

Builder for PermissionedDomain 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 123 of file PermissionedDomain.h.

Constructor & Destructor Documentation

PermissionedDomainBuilder() [1/2]

xrpl::ledger_entries::PermissionedDomainBuilder::PermissionedDomainBuilder	(	std::decay_t< typename SF_ACCOUNT::type::value_type > const &	owner,
		std::decay_t< typename SF_UINT32::type::value_type > const &	sequence,
		STArray const &	acceptedCredentials,
		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 PermissionedDomainBuilder with required fields.

Parameters

owner	The sfOwner field value.
sequence	The sfSequence field value.
acceptedCredentials	The sfAcceptedCredentials field value.
ownerNode	The sfOwnerNode field value.
previousTxnID	The sfPreviousTxnID field value.
previousTxnLgrSeq	The sfPreviousTxnLgrSeq field value.

Definition at line 135 of file PermissionedDomain.h.

PermissionedDomainBuilder() [2/2]

xrpl::ledger_entries::PermissionedDomainBuilder::PermissionedDomainBuilder

(

std::shared_ptr< SLE const >

sle

)

Construct a PermissionedDomainBuilder 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 151 of file PermissionedDomain.h.

Member Function Documentation

setOwner()

PermissionedDomainBuilder & xrpl::ledger_entries::PermissionedDomainBuilder::setOwner

(

std::decay_t< typename SF_ACCOUNT::type::value_type > const &

value

)

Ledger entry-specific field setters.

Set sfOwner (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 167 of file PermissionedDomain.h.

setSequence()

PermissionedDomainBuilder & xrpl::ledger_entries::PermissionedDomainBuilder::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 178 of file PermissionedDomain.h.

setAcceptedCredentials()

PermissionedDomainBuilder & xrpl::ledger_entries::PermissionedDomainBuilder::setAcceptedCredentials

(

STArray const &

value

)

Set sfAcceptedCredentials (soeREQUIRED)

Returns

Reference to this builder for method chaining.

Definition at line 189 of file PermissionedDomain.h.

setOwnerNode()

PermissionedDomainBuilder & xrpl::ledger_entries::PermissionedDomainBuilder::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 200 of file PermissionedDomain.h.

setPreviousTxnID()

PermissionedDomainBuilder & xrpl::ledger_entries::PermissionedDomainBuilder::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 211 of file PermissionedDomain.h.

setPreviousTxnLgrSeq()

PermissionedDomainBuilder & xrpl::ledger_entries::PermissionedDomainBuilder::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 222 of file PermissionedDomain.h.

build()

PermissionedDomain xrpl::ledger_entries::PermissionedDomainBuilder::build

(

uint256 const &

index

)

Build and return the completed PermissionedDomain wrapper.

Parameters

index

The ledger entry index.

Returns

The constructed ledger entry wrapper.

Definition at line 234 of file PermissionedDomain.h.

validate()

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

inherited

Validate the ledger entry.

Returns

true if validation passes, false otherwise

Definition at line 45 of file LedgerEntryBuilderBase.h.

setLedgerIndex()

PermissionedDomainBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< PermissionedDomainBuilder >::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()

PermissionedDomainBuilder & xrpl::ledger_entries::LedgerEntryBuilderBase< PermissionedDomainBuilder >::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< PermissionedDomainBuilder >::object_

protectedinherited

Definition at line 81 of file LedgerEntryBuilderBase.h.