LUSID C# SDK
|
Definition of a Bond Principal Event This is an event that describes the occurence of a cashflow due to the principal payment. More...
Public Member Functions | |
BondPrincipalEvent (string currency=default(string), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), decimal principalPerUnit=default(decimal), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum)) | |
Initializes a new instance of the BondPrincipalEvent 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 (BondPrincipalEvent input) |
Returns true if BondPrincipalEvent 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 | |
BondPrincipalEvent () | |
Initializes a new instance of the BondPrincipalEvent 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 | |
string | Currency [get, set] |
Currency of the principal payment More... | |
DateTimeOffset | ExDate [get, set] |
Ex-Dividend date of the principal payment More... | |
DateTimeOffset | PaymentDate [get, set] |
Payment date of the principal payment More... | |
decimal | PrincipalPerUnit [get, set] |
Principal per unit 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, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent More... | |
Definition of a Bond Principal Event This is an event that describes the occurence of a cashflow due to the principal payment.
|
inlineprotected |
Initializes a new instance of the BondPrincipalEvent class.
|
inline |
Initializes a new instance of the BondPrincipalEvent class.
currency | Currency of the principal payment (required). |
exDate | Ex-Dividend date of the principal payment (required). |
paymentDate | Payment date of the principal payment (required). |
principalPerUnit | Principal per unit (required). |
instrumentEventType | The Type of Event. The available values are: 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 (required) (default to "BondPrincipalEvent"). |
|
inlineprotected |
To validate all properties of the instance
validationContext | Validation context |
|
inline |
Returns true if BondPrincipalEvent instances are equal
input | Instance of BondPrincipalEvent to be compared |
|
inline |
Returns true if objects are equal
input | Object to be compared |
|
inline |
Gets the hash code
|
inlinevirtual |
Returns the JSON string presentation of the object
Reimplemented from Lusid.Sdk.Model.InstrumentEvent.
|
inline |
Returns the string presentation of the object
|
getset |
Currency of the principal payment
Currency of the principal payment
|
getset |
Ex-Dividend date of the principal payment
Ex-Dividend date of the principal payment
|
getset |
Payment date of the principal payment
Payment date of the principal payment
|
getset |
Principal per unit
Principal per unit