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

StockDividendEventAllOf More...

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

Public Types

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
}
 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...
 

Public Member Functions

 StockDividendEventAllOf (DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), UnitsRatio unitsRatio=default(UnitsRatio), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the StockDividendEventAllOf class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
virtual 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 (StockDividendEventAllOf input)
 Returns true if StockDividendEventAllOf instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 StockDividendEventAllOf ()
 Initializes a new instance of the StockDividendEventAllOf class. More...
 

Properties

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...
 
DateTimeOffset? AnnouncementDate [get, set]
 Date on which the dividend was announced / declared. More...
 
DateTimeOffset ExDate [get, set]
 The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. More...
 
DateTimeOffset PaymentDate [get, set]
 The date the company pays out dividends to shareholders. More...
 
DateTimeOffset? RecordDate [get, set]
 Date you have to be the holder of record in order to participate in the tender. More...
 
UnitsRatio UnitsRatio [get, set]
 Gets or Sets UnitsRatio More...
 

Detailed Description

StockDividendEventAllOf

Member Enumeration Documentation

◆ InstrumentEventTypeEnum

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

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

Enumerator
TransitionEvent 

Enum TransitionEvent for value: TransitionEvent

InformationalEvent 

Enum InformationalEvent for value: InformationalEvent

OpenEvent 

Enum OpenEvent for value: OpenEvent

CloseEvent 

Enum CloseEvent for value: CloseEvent

StockSplitEvent 

Enum StockSplitEvent for value: StockSplitEvent

BondDefaultEvent 

Enum BondDefaultEvent for value: BondDefaultEvent

CashDividendEvent 

Enum CashDividendEvent for value: CashDividendEvent

AmortisationEvent 

Enum AmortisationEvent for value: AmortisationEvent

CashFlowEvent 

Enum CashFlowEvent for value: CashFlowEvent

ExerciseEvent 

Enum ExerciseEvent for value: ExerciseEvent

ResetEvent 

Enum ResetEvent for value: ResetEvent

TriggerEvent 

Enum TriggerEvent for value: TriggerEvent

RawVendorEvent 

Enum RawVendorEvent for value: RawVendorEvent

InformationalErrorEvent 

Enum InformationalErrorEvent for value: InformationalErrorEvent

BondCouponEvent 

Enum BondCouponEvent for value: BondCouponEvent

DividendReinvestmentEvent 

Enum DividendReinvestmentEvent for value: DividendReinvestmentEvent

AccumulationEvent 

Enum AccumulationEvent for value: AccumulationEvent

BondPrincipalEvent 

Enum BondPrincipalEvent for value: BondPrincipalEvent

DividendOptionEvent 

Enum DividendOptionEvent for value: DividendOptionEvent

MaturityEvent 

Enum MaturityEvent for value: MaturityEvent

FxForwardSettlementEvent 

Enum FxForwardSettlementEvent for value: FxForwardSettlementEvent

ExpiryEvent 

Enum ExpiryEvent for value: ExpiryEvent

ScripDividendEvent 

Enum ScripDividendEvent for value: ScripDividendEvent

StockDividendEvent 

Enum StockDividendEvent for value: StockDividendEvent

ReverseStockSplitEvent 

Enum ReverseStockSplitEvent for value: ReverseStockSplitEvent

Constructor & Destructor Documentation

◆ StockDividendEventAllOf() [1/2]

Lusid.Sdk.Model.StockDividendEventAllOf.StockDividendEventAllOf ( )
inlineprotected

Initializes a new instance of the StockDividendEventAllOf class.

◆ StockDividendEventAllOf() [2/2]

Lusid.Sdk.Model.StockDividendEventAllOf.StockDividendEventAllOf ( DateTimeOffset?  announcementDate = default(DateTimeOffset?),
DateTimeOffset  exDate = default(DateTimeOffset),
DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset?  recordDate = default(DateTimeOffset?),
UnitsRatio  unitsRatio = default(UnitsRatio),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the StockDividendEventAllOf class.

Parameters
announcementDateDate on which the dividend was announced / declared..
exDateThe first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate. (required).
paymentDateThe date the company pays out dividends to shareholders. (required).
recordDateDate you have to be the holder of record in order to participate in the tender..
unitsRatiounitsRatio (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, AccumulationEvent, BondPrincipalEvent, DividendOptionEvent, MaturityEvent, FxForwardSettlementEvent, ExpiryEvent, ScripDividendEvent, StockDividendEvent, ReverseStockSplitEvent (required).

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if StockDividendEventAllOf instances are equal

Parameters
inputInstance of StockDividendEventAllOf to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

virtual string Lusid.Sdk.Model.StockDividendEventAllOf.ToJson ( )
inlinevirtual

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

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

Date on which the dividend was announced / declared.

Date on which the dividend was announced / declared.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.StockDividendEventAllOf.ExDate
getset

The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate.

The first business day on which the dividend is not owed to the buying party. Typically this is T-1 from the RecordDate.

◆ InstrumentEventType

InstrumentEventTypeEnum Lusid.Sdk.Model.StockDividendEventAllOf.InstrumentEventType
getset

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.StockDividendEventAllOf.PaymentDate
getset

The date the company pays out dividends to shareholders.

The date the company pays out dividends to shareholders.

◆ RecordDate

DateTimeOffset? Lusid.Sdk.Model.StockDividendEventAllOf.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.

◆ UnitsRatio

UnitsRatio Lusid.Sdk.Model.StockDividendEventAllOf.UnitsRatio
getset

Gets or Sets UnitsRatio


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