ores.trading.swaption_instrument

Table of Contents

Represents a swaption — an option granting the right to enter into an interest rate swap at a future date. Exercise type may be European, Bermudan, or American.

Flags

Primary key

UUID uniquely identifying this swaption instrument.

Surrogate key for the instrument record.

Natural keys

Columns

trade_type_code

Trade type code (soft FK to ores_trading_trade_types_tbl).

std::string("EuropeanSwaption")

party_id

Party that owns this instrument.

Set from session variable app.current_party_id.

trade_id

Optional soft FK to the parent trade.

Links instrument to a trade if applicable.

expiry_date

Option expiry date.

ISO 8601 date string (YYYY-MM-DD).

std::string("2025-06-15")

exercise_type

Exercise type: European, Bermudan, or American.

Determines when the option may be exercised.

std::string("European")

settlement_type

Settlement type: Cash or Physical.

Determines how the swaption is settled upon exercise.

std::string("Physical")

long_short

Position direction: Long or Short.

Indicates whether the party holds or writes the option.

std::string("Long")

start_date

Optional underlying swap start date.

ISO 8601 date string (YYYY-MM-DD). Null if not yet determined.

maturity_date

Optional underlying swap maturity date.

ISO 8601 date string (YYYY-MM-DD). Null if not yet determined.

description

Optional free-text description.

Human-readable notes about this instrument.

SQL

Flags

C++

The C++ domain class is decomposed into nested sub-structs (the C1202 pattern from PRs #1047/#1071/#1075/#1083/#1085): the implicit scaffolding columns (version, tenant_id, workspace_id, the primary key) and the columns marked :group: identity below fold into an instrument_identity identity; member (see the ores.trading.instrument_identity field-group model), the implicit audit columns fold into an ores::dq::domain::audit_record audit; member (see the ores.dq.audit_record field-group model), and the remaining columns stay flat in between. The SQL schema, DB entity and column lists are unaffected — only the domain class and the mapper's domain-side accesses nest. The entity templates consume these annotations; domain and repository profiles regenerate correctly.

Flags

Repository

Domain includes

#include <chrono>
#include <string>

Conventions

Custom repository methods

See also

Emacs 29.1 (Org mode 9.6.6)