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

A cash distribution paid out to shareholders. More...

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

Public Member Functions

 CashDividendEvent (DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset exDate=default(DateTimeOffset), List< CashElection > cashElections=default(List< CashElection >), DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset? recordDate=default(DateTimeOffset?), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the CashDividendEvent 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 (CashDividendEvent input)
 Returns true if CashDividendEvent 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

 CashDividendEvent ()
 Initializes a new instance of the CashDividendEvent 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 PaymentDate [get, set]
 The date the company begins distributing the dividend. More...
 
DateTimeOffset ExDate [get, set]
 The first business day on which the dividend is not owed to the buying party. More...
 
List< CashElectionCashElections [get, set]
 Possible elections for this event, each keyed with a unique identifier. More...
 
DateTimeOffset? AnnouncementDate [get, set]
 Date on which the dividend is announced by the company. More...
 
DateTimeOffset? RecordDate [get, set]
 Date you have to be the holder of record in order to participate in the tender. 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 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
}
 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 More...
 

Detailed Description

A cash distribution paid out to shareholders.

Constructor & Destructor Documentation

◆ CashDividendEvent() [1/2]

Lusid.Sdk.Model.CashDividendEvent.CashDividendEvent ( )
inlineprotected

Initializes a new instance of the CashDividendEvent class.

◆ CashDividendEvent() [2/2]

Lusid.Sdk.Model.CashDividendEvent.CashDividendEvent ( DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset  exDate = default(DateTimeOffset),
List< CashElection cashElections = default(List<CashElection>),
DateTimeOffset?  announcementDate = default(DateTimeOffset?),
DateTimeOffset?  recordDate = default(DateTimeOffset?),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the CashDividendEvent class.

Parameters
paymentDateThe date the company begins distributing the dividend. (required).
exDateThe first business day on which the dividend is not owed to the buying party. (required).
cashElectionsPossible elections for this event, each keyed with a unique identifier. (required).
announcementDateDate on which the dividend is announced by the company..
recordDateDate you have to be the holder of record in order to participate in the tender..
instrumentEventTypeThe 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 (required) (default to "CashDividendEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if CashDividendEvent instances are equal

Parameters
inputInstance of CashDividendEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

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

Date on which the dividend is announced by the company.

Date on which the dividend is announced by the company.

◆ CashElections

List<CashElection> Lusid.Sdk.Model.CashDividendEvent.CashElections
getset

Possible elections for this event, each keyed with a unique identifier.

Possible elections for this event, each keyed with a unique identifier.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.CashDividendEvent.ExDate
getset

The first business day on which the dividend is not owed to the buying party.

The first business day on which the dividend is not owed to the buying party.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.CashDividendEvent.PaymentDate
getset

The date the company begins distributing the dividend.

The date the company begins distributing the dividend.

◆ RecordDate

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

Date you have to be the holder of record in order to participate in the tender.

Date you have to be the holder of record in order to participate in the tender.


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