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

IntermediateSecuritiesDistribution event (RHDI), representing the distribution of securities. More...

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

Public Member Functions

 IntermediateSecuritiesDistributionEvent (DateTimeOffset? announcementDate=default(DateTimeOffset?), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset paymentDate=default(DateTimeOffset), NewInstrument newInstrument=default(NewInstrument), UnitsRatio unitsRatio=default(UnitsRatio), decimal? costFactor=default(decimal?), decimal? fractionalUnitsCashPrice=default(decimal?), string fractionalUnitsCashCurrency=default(string), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the IntermediateSecuritiesDistributionEvent 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 (IntermediateSecuritiesDistributionEvent input)
 Returns true if IntermediateSecuritiesDistributionEvent 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

 IntermediateSecuritiesDistributionEvent ()
 Initializes a new instance of the IntermediateSecuritiesDistributionEvent 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]
 Optional. The date the spin-off is announced. More...
 
DateTimeOffset ExDate [get, set]
 The first date on which the holder of record has entitled ownership of the new shares. More...
 
DateTimeOffset? RecordDate [get, set]
 Optional. Date you have to be the holder of record in order to receive the additional shares. More...
 
DateTimeOffset PaymentDate [get, set]
 Date on which the distribution of shares takes place. More...
 
NewInstrument NewInstrument [get, set]
 Gets or Sets NewInstrument More...
 
UnitsRatio UnitsRatio [get, set]
 Gets or Sets UnitsRatio More...
 
decimal? CostFactor [get, set]
 Optional. The fraction of cost that is transferred from the existing shares to the new shares. 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...
 
- 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

IntermediateSecuritiesDistribution event (RHDI), representing the distribution of securities.

Constructor & Destructor Documentation

◆ IntermediateSecuritiesDistributionEvent() [1/2]

Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.IntermediateSecuritiesDistributionEvent ( )
inlineprotected

Initializes a new instance of the IntermediateSecuritiesDistributionEvent class.

◆ IntermediateSecuritiesDistributionEvent() [2/2]

Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.IntermediateSecuritiesDistributionEvent ( DateTimeOffset?  announcementDate = default(DateTimeOffset?),
DateTimeOffset  exDate = default(DateTimeOffset),
DateTimeOffset?  recordDate = default(DateTimeOffset?),
DateTimeOffset  paymentDate = default(DateTimeOffset),
NewInstrument  newInstrument = default(NewInstrument),
UnitsRatio  unitsRatio = default(UnitsRatio),
decimal?  costFactor = default(decimal?),
decimal?  fractionalUnitsCashPrice = default(decimal?),
string  fractionalUnitsCashCurrency = default(string),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the IntermediateSecuritiesDistributionEvent class.

Parameters
announcementDateOptional. The date the spin-off is announced..
exDateThe first date on which the holder of record has entitled ownership of the new shares. (required).
recordDateOptional. Date you have to be the holder of record in order to receive the additional shares..
paymentDateDate on which the distribution of shares takes place. (required).
newInstrumentnewInstrument (required).
unitsRatiounitsRatio (required).
costFactorOptional. The fraction of cost that is transferred from the existing shares to the new shares..
fractionalUnitsCashPriceOptional. Used in calculating cash-in-lieu of fractional shares..
fractionalUnitsCashCurrencyOptional. Used in calculating cash-in-lieu of fractional shares..
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, 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 "IntermediateSecuritiesDistributionEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if IntermediateSecuritiesDistributionEvent instances are equal

Parameters
inputInstance of IntermediateSecuritiesDistributionEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

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

Optional. The date the spin-off is announced.

Optional. The date the spin-off is announced.

◆ CostFactor

decimal? Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.CostFactor
getset

Optional. The fraction of cost that is transferred from the existing shares to the new shares.

Optional. The fraction of cost that is transferred from the existing shares to the new shares.

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.ExDate
getset

The first date on which the holder of record has entitled ownership of the new shares.

The first date on which the holder of record has entitled ownership of the new shares.

◆ FractionalUnitsCashCurrency

string Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.FractionalUnitsCashCurrency
getset

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

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

◆ FractionalUnitsCashPrice

decimal? Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.FractionalUnitsCashPrice
getset

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

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

◆ NewInstrument

NewInstrument Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.NewInstrument
getset

Gets or Sets NewInstrument

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.PaymentDate
getset

Date on which the distribution of shares takes place.

Date on which the distribution of shares takes place.

◆ RecordDate

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

Optional. Date you have to be the holder of record in order to receive the additional shares.

Optional. Date you have to be the holder of record in order to receive the additional shares.

◆ UnitsRatio

UnitsRatio Lusid.Sdk.Model.IntermediateSecuritiesDistributionEvent.UnitsRatio
getset

Gets or Sets UnitsRatio


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