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

A reverse split in the company's shares. Shareholders have their number of shares reduced based on the terms of the stock split. More...

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

Public Member Functions

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

 ReverseStockSplitEvent ()
 Initializes a new instance of the ReverseStockSplitEvent 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]
 Date on which the stock split takes effect. More...
 
DateTimeOffset ExDate [get, set]
 The first date on which the shares will trade at the post-split price. More...
 
UnitsRatio UnitsRatio [get, set]
 Gets or Sets UnitsRatio More...
 
DateTimeOffset? RecordDate [get, set]
 Date you have to be the holder of record in order to have their shares merged. More...
 
DateTimeOffset? AnnouncementDate [get, set]
 Date the reverse stock split was announced. 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 reverse split in the company&#39;s shares. Shareholders have their number of shares reduced based on the terms of the stock split.

Constructor & Destructor Documentation

◆ ReverseStockSplitEvent() [1/2]

Lusid.Sdk.Model.ReverseStockSplitEvent.ReverseStockSplitEvent ( )
inlineprotected

Initializes a new instance of the ReverseStockSplitEvent class.

◆ ReverseStockSplitEvent() [2/2]

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

Initializes a new instance of the ReverseStockSplitEvent class.

Parameters
paymentDateDate on which the stock split takes effect. (required).
exDateThe first date on which the shares will trade at the post-split price. (required).
unitsRatiounitsRatio (required).
recordDateDate you have to be the holder of record in order to have their shares merged..
announcementDateDate the reverse stock split was announced..
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 "ReverseStockSplitEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if ReverseStockSplitEvent instances are equal

Parameters
inputInstance of ReverseStockSplitEvent to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

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

Date the reverse stock split was announced.

Date the reverse stock split was announced.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.ReverseStockSplitEvent.ExDate
getset

The first date on which the shares will trade at the post-split price.

The first date on which the shares will trade at the post-split price.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.ReverseStockSplitEvent.PaymentDate
getset

Date on which the stock split takes effect.

Date on which the stock split takes effect.

◆ RecordDate

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

Date you have to be the holder of record in order to have their shares merged.

Date you have to be the holder of record in order to have their shares merged.

◆ UnitsRatio

UnitsRatio Lusid.Sdk.Model.ReverseStockSplitEvent.UnitsRatio
getset

Gets or Sets UnitsRatio


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