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

Indicates when an issuer has defaulted on an obligation due to technical default, missed payments, or bankruptcy filing. More...

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

Public Member Functions

 BondDefaultEvent (decimal amount=default(decimal), DateTimeOffset couponPaidDate=default(DateTimeOffset), string defaultStatus=default(string), string defaultType=default(string), DateTimeOffset graceEndDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the BondDefaultEvent 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 (BondDefaultEvent input)
 Returns true if BondDefaultEvent 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

 BondDefaultEvent ()
 Initializes a new instance of the BondDefaultEvent 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 Amount [get, set]
 Percentage or amount of each share held to be given to shareholders. More...
 
DateTimeOffset CouponPaidDate [get, set]
 Date that the missed coupon is paid if payment is made within grace period. More...
 
string DefaultStatus [get, set]
 The status of the bond default (i.e., technical or default) Supported string (enumeration) values are: [Technical, Default]. More...
 
string DefaultType [get, set]
 The type of the default. (coupon payment, principal payment, covenant ...) Supported string (enumeration) values are: [CouponPayment, CouponAndPrincipalPayment, PrincipalPayment, Covenant, Bankruptcy, BuyBackOption]. More...
 
DateTimeOffset GraceEndDate [get, set]
 Date the grace period for making coupon payment ends. More...
 
DateTimeOffset PaymentDate [get, set]
 The date the coupon payment was missed. More...
 
- Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum InstrumentEventType [get, set]
 The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent 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
}
 The Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent More...
 

Detailed Description

Indicates when an issuer has defaulted on an obligation due to technical default, missed payments, or bankruptcy filing.

Constructor & Destructor Documentation

◆ BondDefaultEvent() [1/2]

Lusid.Sdk.Model.BondDefaultEvent.BondDefaultEvent ( )
inlineprotected

Initializes a new instance of the BondDefaultEvent class.

◆ BondDefaultEvent() [2/2]

Lusid.Sdk.Model.BondDefaultEvent.BondDefaultEvent ( decimal  amount = default(decimal),
DateTimeOffset  couponPaidDate = default(DateTimeOffset),
string  defaultStatus = default(string),
string  defaultType = default(string),
DateTimeOffset  graceEndDate = default(DateTimeOffset),
DateTimeOffset  paymentDate = default(DateTimeOffset),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the BondDefaultEvent class.

Parameters
amountPercentage or amount of each share held to be given to shareholders. (required).
couponPaidDateDate that the missed coupon is paid if payment is made within grace period. (required).
defaultStatusThe status of the bond default (i.e., technical or default) Supported string (enumeration) values are: [Technical, Default]. (required).
defaultTypeThe type of the default. (coupon payment, principal payment, covenant ...) Supported string (enumeration) values are: [CouponPayment, CouponAndPrincipalPayment, PrincipalPayment, Covenant, Bankruptcy, BuyBackOption]. (required).
graceEndDateDate the grace period for making coupon payment ends. (required).
paymentDateThe date the coupon payment was missed. (required).
instrumentEventTypeThe Type of Event. The available values are: TransitionEvent, InformationalEvent, OpenEvent, CloseEvent, StockSplitEvent, BondDefaultEvent, CashDividendEvent, AmortisationEvent, CashFlowEvent, ExerciseEvent, ResetEvent, TriggerEvent, RawVendorEvent, InformationalErrorEvent, BondCouponEvent, DividendReinvestmentEvent (required) (default to "BondDefaultEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if BondDefaultEvent instances are equal

Parameters
inputInstance of BondDefaultEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

override string Lusid.Sdk.Model.BondDefaultEvent.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.BondDefaultEvent.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ Amount

decimal Lusid.Sdk.Model.BondDefaultEvent.Amount
getset

Percentage or amount of each share held to be given to shareholders.

Percentage or amount of each share held to be given to shareholders.

◆ CouponPaidDate

DateTimeOffset Lusid.Sdk.Model.BondDefaultEvent.CouponPaidDate
getset

Date that the missed coupon is paid if payment is made within grace period.

Date that the missed coupon is paid if payment is made within grace period.

◆ DefaultStatus

string Lusid.Sdk.Model.BondDefaultEvent.DefaultStatus
getset

The status of the bond default (i.e., technical or default) Supported string (enumeration) values are: [Technical, Default].

The status of the bond default (i.e., technical or default) Supported string (enumeration) values are: [Technical, Default].

◆ DefaultType

string Lusid.Sdk.Model.BondDefaultEvent.DefaultType
getset

The type of the default. (coupon payment, principal payment, covenant ...) Supported string (enumeration) values are: [CouponPayment, CouponAndPrincipalPayment, PrincipalPayment, Covenant, Bankruptcy, BuyBackOption].

The type of the default. (coupon payment, principal payment, covenant ...) Supported string (enumeration) values are: [CouponPayment, CouponAndPrincipalPayment, PrincipalPayment, Covenant, Bankruptcy, BuyBackOption].

◆ GraceEndDate

DateTimeOffset Lusid.Sdk.Model.BondDefaultEvent.GraceEndDate
getset

Date the grace period for making coupon payment ends.

Date the grace period for making coupon payment ends.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.BondDefaultEvent.PaymentDate
getset

The date the coupon payment was missed.

The date the coupon payment was missed.


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