corda / net.corda.finance.flows / CashExitFlow

CashExitFlow

@StartableByRPC class CashExitFlow : AbstractCashFlow<Result>

Initiates a flow that produces an cash exit transaction.

Parameters

amount - the amount of a currency to remove from the ledger.

issuerRef - the reference on the issued currency. Added to the node's legal identity to determine the issuer.

Types

ExitRequest

class ExitRequest : AbstractRequest

Constructors

<init>

CashExitFlow(amount: Amount<Currency>, issuerRef: OpaqueBytes)
CashExitFlow(request: ExitRequest)CashExitFlow(amount: Amount<Currency>, issuerRef: OpaqueBytes, progressTracker: ProgressTracker)

Initiates a flow that produces an cash exit transaction.

Inherited Properties

progressTracker

open val progressTracker: ProgressTracker

Override this to provide a ProgressTracker. If one is provided and stepped, the framework will do something helpful with the progress reports e.g record to the audit service. If this flow is invoked as a subflow of another, then the tracker will be made a child of the current step in the parent. If it's null, this flow doesn't track progress.

Functions

call

fun call(): Result

Inherited Functions

finaliseTx

fun finaliseTx(tx: SignedTransaction, extraParticipants: Set<Party>, message: String): SignedTransaction

Companion Object Functions

tracker

fun tracker(): ProgressTracker

Extension Functions

contextLogger

fun Any.contextLogger(): Logger

When called from a companion object, returns the logger for the enclosing class.