LUSID C# SDK
Public Member Functions | Protected Member Functions | Properties | List of all members
Lusid.Sdk.Model.PartialDefeasanceEvent Class Reference

Partial Defeasance event (PDEF). A mandatory notification that a bond issuer has escrow-funded (defeased) a portion of an outstanding issue. No cash flows to holders at this event; the position is marked pre-refunded and its effective maturity is updated to the future call date carried in ActualPayDate. The actual cash and position retirement arrive later via a separate mandatory call event. Supports a Partial Pre-Refunding variant (PPRE). More...

Inheritance diagram for Lusid.Sdk.Model.PartialDefeasanceEvent:
Inheritance graph
[legend]

Public Member Functions

 PartialDefeasanceEvent (decimal refundedFraction=default(decimal), DateTimeOffset effectiveDate=default(DateTimeOffset), DateTimeOffset actualPayDate=default(DateTimeOffset), NewInstrument refundedInstrument=default(NewInstrument), string newSecuritiesIndicator=default(string), string additionalBusinessProcess=default(string), DateTimeOffset? lotteryDate=default(DateTimeOffset?), DateTimeOffset? publicationDate=default(DateTimeOffset?), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset? announcementDate=default(DateTimeOffset?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the PartialDefeasanceEvent class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (PartialDefeasanceEvent input)
 Returns true if PartialDefeasanceEvent instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
- Public Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
 InstrumentEvent (InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the InstrumentEvent class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
override bool Equals (object input)
 Returns true if objects are equal More...
 
bool Equals (InstrumentEvent input)
 Returns true if InstrumentEvent instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 PartialDefeasanceEvent ()
 Initializes a new instance of the PartialDefeasanceEvent class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 
- Protected Member Functions inherited from Lusid.Sdk.Model.InstrumentEvent
 InstrumentEvent ()
 Initializes a new instance of the InstrumentEvent class. More...
 
IEnumerable< System.ComponentModel.DataAnnotations.ValidationResult > BaseValidate (ValidationContext validationContext)
 To validate all properties of the instance More...
 

Properties

decimal RefundedFraction [get, set]
 The issue-level fraction allocated to the refunded (pre-refunded / escrowed) portion. Strictly in the half-open interval (0, 1]; the non-refunded fraction is the derived complement. This is a required field. More...
 
DateTimeOffset EffectiveDate [get, set]
 The date the defeasance status takes effect on the position. This is a required field. More...
 
DateTimeOffset ActualPayDate [get, set]
 The future call date when the bond will actually be retired, used to update the position&#39;s effective maturity in analytics. Must be on or after EffectiveDate. This is a required field. More...
 
NewInstrument RefundedInstrument [get, set]
 Gets or Sets RefundedInstrument More...
 
string NewSecuritiesIndicator [get, set]
 Optional audit field preserving the wire-side codeword used for the refunded portion. Supported string (enumeration) values are: [REFU, DEFE]. Both encodings carry identical semantics. Available values: REFU, DEFE. More...
 
string AdditionalBusinessProcess [get, set]
 Optional variant indicator. Supported string (enumeration) values are: [PPRE]. Absence (null) encodes the default Partial Defeasance variant. Available values: PPRE. More...
 
DateTimeOffset? LotteryDate [get, set]
 Optional. The wire&#39;s lottery date; null when the wire carried a sentinel value. More...
 
DateTimeOffset? PublicationDate [get, set]
 Optional informational date identifying when the defeasance was publicly noticed. More...
 
DateTimeOffset? RecordDate [get, set]
 Optional. The wire&#39;s record date; typically null for a notification event with no distribution. More...
 
DateTimeOffset? AnnouncementDate [get, set]
 Optional informational announcement date; null when not provided. More...
 
- Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum InstrumentEventType [get, set]
 The Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent, BankruptcyEvent, LiquidationPaymentEvent, PartialDefeasanceEvent, SecurityWriteOffEvent, WarrantsExerciseEvent. More...
 

Additional Inherited Members

- Public Types inherited from Lusid.Sdk.Model.InstrumentEvent
enum class  InstrumentEventTypeEnum {
  TransitionEvent = 1 , InformationalEvent = 2 , OpenEvent = 3 , CloseEvent = 4 ,
  StockSplitEvent = 5 , BondDefaultEvent = 6 , CashDividendEvent = 7 , AmortisationEvent = 8 ,
  CashFlowEvent = 9 , ExerciseEvent = 10 , ResetEvent = 11 , TriggerEvent = 12 ,
  RawVendorEvent = 13 , InformationalErrorEvent = 14 , BondCouponEvent = 15 , DividendReinvestmentEvent = 16 ,
  AccumulationEvent = 17 , BondPrincipalEvent = 18 , DividendOptionEvent = 19 , MaturityEvent = 20 ,
  FxForwardSettlementEvent = 21 , ExpiryEvent = 22 , ScripDividendEvent = 23 , StockDividendEvent = 24 ,
  ReverseStockSplitEvent = 25 , CapitalDistributionEvent = 26 , SpinOffEvent = 27 , MergerEvent = 28 ,
  FutureExpiryEvent = 29 , SwapCashFlowEvent = 30 , SwapPrincipalEvent = 31 , CreditPremiumCashFlowEvent = 32 ,
  CdsCreditEvent = 33 , CdxCreditEvent = 34 , MbsCouponEvent = 35 , MbsPrincipalEvent = 36 ,
  BonusIssueEvent = 37 , MbsPrincipalWriteOffEvent = 38 , MbsInterestDeferralEvent = 39 , MbsInterestShortfallEvent = 40 ,
  TenderEvent = 41 , CallOnIntermediateSecuritiesEvent = 42 , IntermediateSecuritiesDistributionEvent = 43 , OptionExercisePhysicalEvent = 44 ,
  OptionExerciseCashEvent = 45 , ProtectionPayoutCashFlowEvent = 46 , TermDepositInterestEvent = 47 , TermDepositPrincipalEvent = 48 ,
  EarlyRedemptionEvent = 49 , FutureMarkToMarketEvent = 50 , AdjustGlobalCommitmentEvent = 51 , ContractInitialisationEvent = 52 ,
  DrawdownEvent = 53 , LoanInterestRepaymentEvent = 54 , UpdateDepositAmountEvent = 55 , LoanPrincipalRepaymentEvent = 56 ,
  DepositInterestPaymentEvent = 57 , DepositCloseEvent = 58 , LoanFacilityContractRolloverEvent = 59 , RepurchaseOfferEvent = 60 ,
  RepoPartialClosureEvent = 61 , RepoCashFlowEvent = 62 , FlexibleRepoInterestPaymentEvent = 63 , FlexibleRepoCashFlowEvent = 64 ,
  FlexibleRepoCollateralEvent = 65 , ConversionEvent = 66 , FlexibleRepoPartialClosureEvent = 67 , FlexibleRepoFullClosureEvent = 68 ,
  CapletFloorletCashFlowEvent = 69 , EarlyCloseOutEvent = 70 , DepositRollEvent = 71 , ConsentEvent = 72 ,
  DrawingEvent = 73 , CapitalGainsDistributionEvent = 74 , ExchangeOfferEvent = 75 , DutchAuctionEvent = 76 ,
  WorthlessEvent = 77 , PutRedemptionEvent = 78 , LoanFacilityDelayedCompensationPaymentEvent = 79 , InterestPaymentEvent = 80 ,
  PriorityIssueEvent = 81 , ClassActionEvent = 82 , BankruptcyEvent = 83 , LiquidationPaymentEvent = 84 ,
  PartialDefeasanceEvent = 85 , SecurityWriteOffEvent = 86 , WarrantsExerciseEvent = 87
}
 The Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent, BankruptcyEvent, LiquidationPaymentEvent, PartialDefeasanceEvent, SecurityWriteOffEvent, WarrantsExerciseEvent. More...
 

Detailed Description

Partial Defeasance event (PDEF). A mandatory notification that a bond issuer has escrow-funded (defeased) a portion of an outstanding issue. No cash flows to holders at this event; the position is marked pre-refunded and its effective maturity is updated to the future call date carried in ActualPayDate. The actual cash and position retirement arrive later via a separate mandatory call event. Supports a Partial Pre-Refunding variant (PPRE).

Constructor & Destructor Documentation

◆ PartialDefeasanceEvent() [1/2]

Lusid.Sdk.Model.PartialDefeasanceEvent.PartialDefeasanceEvent ( )
inlineprotected

Initializes a new instance of the PartialDefeasanceEvent class.

◆ PartialDefeasanceEvent() [2/2]

Lusid.Sdk.Model.PartialDefeasanceEvent.PartialDefeasanceEvent ( decimal  refundedFraction = default(decimal),
DateTimeOffset  effectiveDate = default(DateTimeOffset),
DateTimeOffset  actualPayDate = default(DateTimeOffset),
NewInstrument  refundedInstrument = default(NewInstrument),
string  newSecuritiesIndicator = default(string),
string  additionalBusinessProcess = default(string),
DateTimeOffset?  lotteryDate = default(DateTimeOffset?),
DateTimeOffset?  publicationDate = default(DateTimeOffset?),
DateTimeOffset?  recordDate = default(DateTimeOffset?),
DateTimeOffset?  announcementDate = default(DateTimeOffset?),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the PartialDefeasanceEvent class.

Parameters
refundedFractionThe issue-level fraction allocated to the refunded (pre-refunded / escrowed) portion. Strictly in the half-open interval (0, 1]; the non-refunded fraction is the derived complement. This is a required field. (required).
effectiveDateThe date the defeasance status takes effect on the position. This is a required field..
actualPayDateThe future call date when the bond will actually be retired, used to update the position&#39;s effective maturity in analytics. Must be on or after EffectiveDate. This is a required field..
refundedInstrumentrefundedInstrument.
newSecuritiesIndicatorOptional audit field preserving the wire-side codeword used for the refunded portion. Supported string (enumeration) values are: [REFU, DEFE]. Both encodings carry identical semantics. Available values: REFU, DEFE..
additionalBusinessProcessOptional variant indicator. Supported string (enumeration) values are: [PPRE]. Absence (null) encodes the default Partial Defeasance variant. Available values: PPRE..
lotteryDateOptional. The wire&#39;s lottery date; null when the wire carried a sentinel value..
publicationDateOptional informational date identifying when the defeasance was publicly noticed..
recordDateOptional. The wire&#39;s record date; typically null for a notification event with no distribution..
announcementDateOptional informational announcement date; null when not provided..
instrumentEventTypeThe Type of Event. Available values: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent, CapitalDistributionEvent, SpinOffEvent, MergerEvent, FutureExpiryEvent, SwapCashFlowEvent, SwapPrincipalEvent, CreditPremiumCashFlowEvent, CdsCreditEvent, CdxCreditEvent, MbsCouponEvent, MbsPrincipalEvent, BonusIssueEvent, MbsPrincipalWriteOffEvent, MbsInterestDeferralEvent, MbsInterestShortfallEvent, TenderEvent, CallOnIntermediateSecuritiesEvent, IntermediateSecuritiesDistributionEvent, OptionExercisePhysicalEvent, OptionExerciseCashEvent, ProtectionPayoutCashFlowEvent, TermDepositInterestEvent, TermDepositPrincipalEvent, EarlyRedemptionEvent, FutureMarkToMarketEvent, AdjustGlobalCommitmentEvent, ContractInitialisationEvent, DrawdownEvent, LoanInterestRepaymentEvent, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent, BankruptcyEvent, LiquidationPaymentEvent, PartialDefeasanceEvent, SecurityWriteOffEvent, WarrantsExerciseEvent. (required) (default to "PartialDefeasanceEvent").

Member Function Documentation

◆ BaseValidate()

IEnumerable<System.ComponentModel.DataAnnotations.ValidationResult> Lusid.Sdk.Model.PartialDefeasanceEvent.BaseValidate ( ValidationContext  validationContext)
inlineprotected

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.PartialDefeasanceEvent.Equals ( object  input)
inline

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.PartialDefeasanceEvent.Equals ( PartialDefeasanceEvent  input)
inline

Returns true if PartialDefeasanceEvent instances are equal

Parameters
inputInstance of PartialDefeasanceEvent to be compared
Returns
Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.PartialDefeasanceEvent.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.PartialDefeasanceEvent.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

Reimplemented from Lusid.Sdk.Model.InstrumentEvent.

◆ ToString()

override string Lusid.Sdk.Model.PartialDefeasanceEvent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ActualPayDate

DateTimeOffset Lusid.Sdk.Model.PartialDefeasanceEvent.ActualPayDate
getset

The future call date when the bond will actually be retired, used to update the position&#39;s effective maturity in analytics. Must be on or after EffectiveDate. This is a required field.

The future call date when the bond will actually be retired, used to update the position&#39;s effective maturity in analytics. Must be on or after EffectiveDate. This is a required field.

◆ AdditionalBusinessProcess

string Lusid.Sdk.Model.PartialDefeasanceEvent.AdditionalBusinessProcess
getset

Optional variant indicator. Supported string (enumeration) values are: [PPRE]. Absence (null) encodes the default Partial Defeasance variant. Available values: PPRE.

Optional variant indicator. Supported string (enumeration) values are: [PPRE]. Absence (null) encodes the default Partial Defeasance variant. Available values: PPRE.

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.PartialDefeasanceEvent.AnnouncementDate
getset

Optional informational announcement date; null when not provided.

Optional informational announcement date; null when not provided.

◆ EffectiveDate

DateTimeOffset Lusid.Sdk.Model.PartialDefeasanceEvent.EffectiveDate
getset

The date the defeasance status takes effect on the position. This is a required field.

The date the defeasance status takes effect on the position. This is a required field.

◆ LotteryDate

DateTimeOffset? Lusid.Sdk.Model.PartialDefeasanceEvent.LotteryDate
getset

Optional. The wire&#39;s lottery date; null when the wire carried a sentinel value.

Optional. The wire&#39;s lottery date; null when the wire carried a sentinel value.

◆ NewSecuritiesIndicator

string Lusid.Sdk.Model.PartialDefeasanceEvent.NewSecuritiesIndicator
getset

Optional audit field preserving the wire-side codeword used for the refunded portion. Supported string (enumeration) values are: [REFU, DEFE]. Both encodings carry identical semantics. Available values: REFU, DEFE.

Optional audit field preserving the wire-side codeword used for the refunded portion. Supported string (enumeration) values are: [REFU, DEFE]. Both encodings carry identical semantics. Available values: REFU, DEFE.

◆ PublicationDate

DateTimeOffset? Lusid.Sdk.Model.PartialDefeasanceEvent.PublicationDate
getset

Optional informational date identifying when the defeasance was publicly noticed.

Optional informational date identifying when the defeasance was publicly noticed.

◆ RecordDate

DateTimeOffset? Lusid.Sdk.Model.PartialDefeasanceEvent.RecordDate
getset

Optional. The wire&#39;s record date; typically null for a notification event with no distribution.

Optional. The wire&#39;s record date; typically null for a notification event with no distribution.

◆ RefundedFraction

decimal Lusid.Sdk.Model.PartialDefeasanceEvent.RefundedFraction
getset

The issue-level fraction allocated to the refunded (pre-refunded / escrowed) portion. Strictly in the half-open interval (0, 1]; the non-refunded fraction is the derived complement. This is a required field.

The issue-level fraction allocated to the refunded (pre-refunded / escrowed) portion. Strictly in the half-open interval (0, 1]; the non-refunded fraction is the derived complement. This is a required field.

◆ RefundedInstrument

NewInstrument Lusid.Sdk.Model.PartialDefeasanceEvent.RefundedInstrument
getset

Gets or Sets RefundedInstrument


The documentation for this class was generated from the following file: