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

AccumulationEventAllOf More...

Inheritance diagram for Lusid.Sdk.Model.AccumulationEventAllOf:
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

 AccumulationEventAllOf (DateTimeOffset? announcementDate=default(DateTimeOffset?), string dividendCurrency=default(string), decimal dividendRate=default(decimal), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the AccumulationEventAllOf 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 (AccumulationEventAllOf input)
 Returns true if AccumulationEventAllOf instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 

Protected Member Functions

 AccumulationEventAllOf ()
 Initializes a new instance of the AccumulationEventAllOf 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...
 
string DividendCurrency [get, set]
 Payment currency More...
 
decimal DividendRate [get, set]
 Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05 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...
 

Detailed Description

AccumulationEventAllOf

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

◆ AccumulationEventAllOf() [1/2]

Lusid.Sdk.Model.AccumulationEventAllOf.AccumulationEventAllOf ( )
inlineprotected

Initializes a new instance of the AccumulationEventAllOf class.

◆ AccumulationEventAllOf() [2/2]

Lusid.Sdk.Model.AccumulationEventAllOf.AccumulationEventAllOf ( DateTimeOffset?  announcementDate = default(DateTimeOffset?),
string  dividendCurrency = default(string),
decimal  dividendRate = default(decimal),
DateTimeOffset  exDate = default(DateTimeOffset),
DateTimeOffset  paymentDate = default(DateTimeOffset),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the AccumulationEventAllOf class.

Parameters
announcementDateDate on which the dividend was announced / declared..
dividendCurrencyPayment currency (required).
dividendRateDividend rate or payment rate as a percentage. i.e. 5% is written as 0.05 (required).
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).
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]

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

Returns true if AccumulationEventAllOf instances are equal

Parameters
inputInstance of AccumulationEventAllOf to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

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

Date on which the dividend was announced / declared.

Date on which the dividend was announced / declared.

◆ DividendCurrency

string Lusid.Sdk.Model.AccumulationEventAllOf.DividendCurrency
getset

Payment currency

Payment currency

◆ DividendRate

decimal Lusid.Sdk.Model.AccumulationEventAllOf.DividendRate
getset

Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05

Dividend rate or payment rate as a percentage. i.e. 5% is written as 0.05

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.AccumulationEventAllOf.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.AccumulationEventAllOf.InstrumentEventType
getset

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.AccumulationEventAllOf.PaymentDate
getset

The date the company pays out dividends to shareholders.

The date the company pays out dividends to shareholders.


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