docs/net.corda.finance.contracts.asset/Obligation/Commands

Commands

Types

data class Exit<P : Any>(val amount: Amount<Issued<Obligation.Terms<P>>>) : CommandData

A command stating that the debt is being released by the beneficiary. Normally would indicate either settlement outside of the ledger, or that the obligor is unable to pay.

Issue

class Issue : TypeOnlyCommandData

Allows new obligation states to be issued into existence.

Move

data class Move(val contract: Class<out Contract>? = null) : MoveCommand

A command stating that a debt has been moved, optionally to fulfil another contract.

Net

data class Net(val type: NetType) : NetCommand

Net two or more obligation states together in a close-out netting style. Limited to bilateral netting as only the beneficiary (not the obligor) needs to sign.

SetLifecycle

data class SetLifecycle(val lifecycle: Obligation.Lifecycle) : CommandData

A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled by the due date, or resetting a defaulted contract back to the issued state.

Settle

data class Settle<P : Any>(val amount: Amount<Issued<Obligation.Terms<P>>>) : CommandData

A command stating that the obligor is settling some or all of the amount owed by transferring a suitable state object to the beneficiary. If this reduces the balance to zero, the state object is destroyed.