Representation of a Bonus Issue corporate action. More...

Inheritance diagram for Lusid.Sdk.Model.BonusIssueEvent:

[legend]

Public Member Functions
	BonusIssueEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset paymentDate=default(DateTimeOffset), decimal? fractionalUnitsCashPrice=default(decimal?), string fractionalUnitsCashCurrency=default(string), List< SecurityOfferElection > securityOfferElections=default(List< SecurityOfferElection >), List< CashOfferElection > cashOfferElections=default(List< CashOfferElection >), List< LapseElection > lapseElections=default(List< LapseElection >), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the BonusIssueEvent 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 (BonusIssueEvent input)
	Returns true if BonusIssueEvent 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
	BonusIssueEvent ()
	Initializes a new instance of the BonusIssueEvent 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
DateTimeOffset?	AnnouncementDate `[get, set]`
	The date the Bonus Issue is announced. More...

DateTimeOffset	ExDate `[get, set]`
	The ex-date of the Bonus Issue. More...

DateTimeOffset?	RecordDate `[get, set]`
	The record date of the Bonus Issue. More...

DateTimeOffset	PaymentDate `[get, set]`
	The date the Bonus Issue is executed. More...

decimal?	FractionalUnitsCashPrice `[get, set]`
	Optional. Used in calculating cash-in-lieu of fractional shares. More...

string	FractionalUnitsCashCurrency `[get, set]`
	Optional. Used in calculating cash-in-lieu of fractional shares. More...

List< SecurityOfferElection >	SecurityOfferElections `[get, set]`
	Possible SecurityElections for this Bonus Issue event, if any. More...

List< CashOfferElection >	CashOfferElections `[get, set]`
	Possible CashOfferElections for this Bonus Issue event, if any. More...

List< LapseElection >	LapseElections `[get, set]`
	Possible LapseElections for this Bonus Issue event, if any. 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, 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 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 }
	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, 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 More...

Detailed Description

Representation of a Bonus Issue corporate action.

Constructor & Destructor Documentation

◆ BonusIssueEvent() [1/2]

Lusid.Sdk.Model.BonusIssueEvent.BonusIssueEvent ( )

inlineprotected

Initializes a new instance of the BonusIssueEvent class.

◆ BonusIssueEvent() [2/2]

Lusid.Sdk.Model.BonusIssueEvent.BonusIssueEvent	(	DateTimeOffset?	announcementDate = `default(DateTimeOffset?)`,
		DateTimeOffset	exDate = `default(DateTimeOffset)`,
		DateTimeOffset?	recordDate = `default(DateTimeOffset?)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		decimal?	fractionalUnitsCashPrice = `default(decimal?)`,
		string	fractionalUnitsCashCurrency = `default(string)`,
		List< SecurityOfferElection >	securityOfferElections = `default(List<SecurityOfferElection>)`,
		List< CashOfferElection >	cashOfferElections = `default(List<CashOfferElection>)`,
		List< LapseElection >	lapseElections = `default(List<LapseElection>)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the BonusIssueEvent class.

Parameters

announcementDate	The date the Bonus Issue is announced..
exDate	The ex-date of the Bonus Issue. (required).
recordDate	The record date of the Bonus Issue..
paymentDate	The date the Bonus Issue is executed. (required).
fractionalUnitsCashPrice	Optional. Used in calculating cash-in-lieu of fractional shares..
fractionalUnitsCashCurrency	Optional. Used in calculating cash-in-lieu of fractional shares..
securityOfferElections	Possible SecurityElections for this Bonus Issue event, if any..
cashOfferElections	Possible CashOfferElections for this Bonus Issue event, if any..
lapseElections	Possible LapseElections for this Bonus Issue event, if any..
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, 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 (required) (default to "BonusIssueEvent").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

bool Lusid.Sdk.Model.BonusIssueEvent.Equals ( BonusIssueEvent input )

inline

Returns true if BonusIssueEvent instances are equal

Parameters

input Instance of BonusIssueEvent to be compared

Returns: Boolean

◆ Equals() [2/2]

override bool Lusid.Sdk.Model.BonusIssueEvent.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.BonusIssueEvent.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset? Lusid.Sdk.Model.BonusIssueEvent.AnnouncementDate

getset

The date the Bonus Issue is announced.

◆ CashOfferElections

List<CashOfferElection> Lusid.Sdk.Model.BonusIssueEvent.CashOfferElections

getset

Possible CashOfferElections for this Bonus Issue event, if any.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.BonusIssueEvent.ExDate

getset

The ex-date of the Bonus Issue.

◆ FractionalUnitsCashCurrency

string Lusid.Sdk.Model.BonusIssueEvent.FractionalUnitsCashCurrency

getset

Optional. Used in calculating cash-in-lieu of fractional shares.

◆ FractionalUnitsCashPrice

decimal? Lusid.Sdk.Model.BonusIssueEvent.FractionalUnitsCashPrice

getset

Optional. Used in calculating cash-in-lieu of fractional shares.

◆ LapseElections

List<LapseElection> Lusid.Sdk.Model.BonusIssueEvent.LapseElections

getset

Possible LapseElections for this Bonus Issue event, if any.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.BonusIssueEvent.PaymentDate

getset

The date the Bonus Issue is executed.

◆ RecordDate

DateTimeOffset? Lusid.Sdk.Model.BonusIssueEvent.RecordDate

getset

The record date of the Bonus Issue.

◆ SecurityOfferElections

List<SecurityOfferElection> Lusid.Sdk.Model.BonusIssueEvent.SecurityOfferElections

getset

Possible SecurityElections for this Bonus Issue event, if any.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/BonusIssueEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BonusIssueEvent() [1/2]

◆ BonusIssueEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnnouncementDate

◆ CashOfferElections

◆ ExDate

◆ FractionalUnitsCashCurrency

◆ FractionalUnitsCashPrice

◆ LapseElections

◆ PaymentDate

◆ RecordDate

◆ SecurityOfferElections