com.r3corda.contracts.asset / Obligation

# Obligation

`class Obligation<P> : ClauseVerifier`

An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the Cash contract) at a specified future point in time. Settlement transactions may split and merge contracts across multiple input and output states. The goal of this design is to handle amounts owed, and these contracts are expected to be netted/merged, with settlement only for any remainder amount.

### Parameters

`P` - the product the obligation is for payment of.

### Types

Clauses | `interface Clauses`
Commands | `interface Commands : Commands`
Lifecycle | `enum class Lifecycle` Represents where in its lifecycle a contract state is, which in turn controls the commands that can be applied to the state. Most states will not leave the NORMAL lifecycle. Note that settled (as an end lifecycle) is represented by absence of the state on transaction output.
State | `data class State<P> : FungibleAsset<Terms<P>>, NettableState<State<P>, MultilateralNetState<P>>` A state representing the obligation of one party (obligor) to deliver a specified number of units of an underlying asset (described as token.acceptableIssuedProducts) to the beneficiary no later than the specified time.
Terms | `data class Terms<P>` Subset of state, containing the elements specified when issuing a new settlement contract.

### Constructors

<init> | `Obligation()` An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the Cash contract) at a specified future point in time. Settlement transactions may split and merge contracts across multiple input and output states. The goal of this design is to handle amounts owed, and these contracts are expected to be netted/merged, with settlement only for any remainder amount.

### Properties

clauses | `val clauses: List<SingleClause>`
legalContractReference | `val legalContractReference: SecureHash` TODO:

### Functions

extractCommands | `fun extractCommands(tx: TransactionForContract): List<AuthenticatedObject<Commands>>`
generateCloseOutNetting | `fun generateCloseOutNetting(tx: TransactionBuilder, signer: PublicKey, vararg states: State<P>): Unit` Generate a transaction performing close-out netting of two or more states.
generateIssue | `fun generateIssue(tx: TransactionBuilder, obligor: Party, issuanceDef: Terms<P>, pennies: Long, beneficiary: PublicKey, notary: Party): Unit` Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.
generatePaymentNetting | `fun generatePaymentNetting(tx: TransactionBuilder, issued: Issued<Terms<P>>, notary: Party, vararg states: State<P>): Unit`
generateSetLifecycle | `fun generateSetLifecycle(tx: TransactionBuilder, statesAndRefs: List<StateAndRef<State<P>>>, lifecycle: Lifecycle, notary: Party): Unit` Generate a transaction changing the lifecycle of one or more state objects.
generateSettle | `fun generateSettle(tx: TransactionBuilder, statesAndRefs: Iterable<StateAndRef<State<P>>>, assetStatesAndRefs: Iterable<StateAndRef<FungibleAsset<P>>>, moveCommand: MoveCommand, notary: Party): Unit`
verifySetLifecycleCommand | `fun verifySetLifecycleCommand(inputs: List<FungibleAsset<Terms<P>>>, outputs: List<FungibleAsset<Terms<P>>>, tx: TransactionForContract, setLifecycleCommand: AuthenticatedObject<SetLifecycle>): Unit` A default command mutates inputs and produces identical outputs, except that the lifecycle changes.

### Inherited Functions

verify | `open fun verify(tx: TransactionForContract): Unit` Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense. Must throw an exception if theres a problem that should prevent state transition. Takes a single object rather than an argument so that additional data can be added without breaking binary compatibility with existing contract code.