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

Class Action Event (CLSA) — a voluntary corporate action under which security holders receive cash compensation from a court-approved settlement fund following litigation against an issuer. More...

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

Public Member Functions

 ClassActionEvent (DateTimeOffset paymentDate=default(DateTimeOffset), DateTimeOffset filingDeadline=default(DateTimeOffset), DateTimeOffset classPeriodStart=default(DateTimeOffset), DateTimeOffset classPeriodEnd=default(DateTimeOffset), DateTimeOffset? exDate=default(DateTimeOffset?), DateTimeOffset? recordDate=default(DateTimeOffset?), DateTimeOffset? announcementDate=default(DateTimeOffset?), string caseReference=default(string), List< CashOfferElection > cashOfferElections=default(List< CashOfferElection >), List< LapseElection > lapseElections=default(List< LapseElection >), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
 Initializes a new instance of the ClassActionEvent 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 (ClassActionEvent input)
 Returns true if ClassActionEvent 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

 ClassActionEvent ()
 Initializes a new instance of the ClassActionEvent 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 settlement distribution is paid to the holder. More...
 
DateTimeOffset FilingDeadline [get, set]
 Court-set deadline for submitting a proof of claim. More...
 
DateTimeOffset ClassPeriodStart [get, set]
 Lower bound of the eligibility window (inclusive). More...
 
DateTimeOffset ClassPeriodEnd [get, set]
 Upper bound of the eligibility window (inclusive). More...
 
DateTimeOffset? ExDate [get, set]
 Date from which the security trades without the settlement right. Null for most class actions where no ex date is defined. More...
 
DateTimeOffset? RecordDate [get, set]
 Date at which positions are struck for notification scope. Informational only. More...
 
DateTimeOffset? AnnouncementDate [get, set]
 Settlement public-announcement or court-approval date. More...
 
string CaseReference [get, set]
 Lawsuit or settlement-fund identifier (court case number, fund name). Audit-only. More...
 
List< CashOfferElectionCashOfferElections [get, set]
 Cash offer elections for this event. Exactly one entry carrying the per-share settlement amount as CashOfferPrice and settlement currency as CashOfferCurrency. More...
 
List< LapseElectionLapseElections [get, set]
 Lapse elections for this event. Exactly one entry (NOAC) with IsDefault &#x3D; true. More...
 
- Properties inherited from Lusid.Sdk.Model.InstrumentEvent
InstrumentEventTypeEnum InstrumentEventType [get, set]
 The Type of Event. Available values: 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, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent. 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 , UpdateDepositAmountEvent = 55 , LoanPrincipalRepaymentEvent = 56 ,
  DepositInterestPaymentEvent = 57 , DepositCloseEvent = 58 , LoanFacilityContractRolloverEvent = 59 , RepurchaseOfferEvent = 60 ,
  RepoPartialClosureEvent = 61 , RepoCashFlowEvent = 62 , FlexibleRepoInterestPaymentEvent = 63 , FlexibleRepoCashFlowEvent = 64 ,
  FlexibleRepoCollateralEvent = 65 , ConversionEvent = 66 , FlexibleRepoPartialClosureEvent = 67 , FlexibleRepoFullClosureEvent = 68 ,
  CapletFloorletCashFlowEvent = 69 , EarlyCloseOutEvent = 70 , DepositRollEvent = 71 , ConsentEvent = 72 ,
  DrawingEvent = 73 , CapitalGainsDistributionEvent = 74 , ExchangeOfferEvent = 75 , DutchAuctionEvent = 76 ,
  WorthlessEvent = 77 , PutRedemptionEvent = 78 , LoanFacilityDelayedCompensationPaymentEvent = 79 , InterestPaymentEvent = 80 ,
  PriorityIssueEvent = 81 , ClassActionEvent = 82
}
 The Type of Event. Available values: 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, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent. More...
 

Detailed Description

Class Action Event (CLSA) — a voluntary corporate action under which security holders receive cash compensation from a court-approved settlement fund following litigation against an issuer.

Constructor & Destructor Documentation

◆ ClassActionEvent() [1/2]

Lusid.Sdk.Model.ClassActionEvent.ClassActionEvent ( )
inlineprotected

Initializes a new instance of the ClassActionEvent class.

◆ ClassActionEvent() [2/2]

Lusid.Sdk.Model.ClassActionEvent.ClassActionEvent ( DateTimeOffset  paymentDate = default(DateTimeOffset),
DateTimeOffset  filingDeadline = default(DateTimeOffset),
DateTimeOffset  classPeriodStart = default(DateTimeOffset),
DateTimeOffset  classPeriodEnd = default(DateTimeOffset),
DateTimeOffset?  exDate = default(DateTimeOffset?),
DateTimeOffset?  recordDate = default(DateTimeOffset?),
DateTimeOffset?  announcementDate = default(DateTimeOffset?),
string  caseReference = default(string),
List< CashOfferElection cashOfferElections = default(List<CashOfferElection>),
List< LapseElection lapseElections = default(List<LapseElection>),
InstrumentEventTypeEnum  instrumentEventType = default(InstrumentEventTypeEnum) 
)
inline

Initializes a new instance of the ClassActionEvent class.

Parameters
paymentDateDate on which the settlement distribution is paid to the holder..
filingDeadlineCourt-set deadline for submitting a proof of claim..
classPeriodStartLower bound of the eligibility window (inclusive)..
classPeriodEndUpper bound of the eligibility window (inclusive)..
exDateDate from which the security trades without the settlement right. Null for most class actions where no ex date is defined..
recordDateDate at which positions are struck for notification scope. Informational only..
announcementDateSettlement public-announcement or court-approval date..
caseReferenceLawsuit or settlement-fund identifier (court case number, fund name). Audit-only..
cashOfferElectionsCash offer elections for this event. Exactly one entry carrying the per-share settlement amount as CashOfferPrice and settlement currency as CashOfferCurrency..
lapseElectionsLapse elections for this event. Exactly one entry (NOAC) with IsDefault &#x3D; true..
instrumentEventTypeThe Type of Event. Available values: 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, UpdateDepositAmountEvent, LoanPrincipalRepaymentEvent, DepositInterestPaymentEvent, DepositCloseEvent, LoanFacilityContractRolloverEvent, RepurchaseOfferEvent, RepoPartialClosureEvent, RepoCashFlowEvent, FlexibleRepoInterestPaymentEvent, FlexibleRepoCashFlowEvent, FlexibleRepoCollateralEvent, ConversionEvent, FlexibleRepoPartialClosureEvent, FlexibleRepoFullClosureEvent, CapletFloorletCashFlowEvent, EarlyCloseOutEvent, DepositRollEvent, ConsentEvent, DrawingEvent, CapitalGainsDistributionEvent, ExchangeOfferEvent, DutchAuctionEvent, WorthlessEvent, PutRedemptionEvent, LoanFacilityDelayedCompensationPaymentEvent, InterestPaymentEvent, PriorityIssueEvent, ClassActionEvent. (required) (default to "ClassActionEvent").

Member Function Documentation

◆ BaseValidate()

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

To validate all properties of the instance

Parameters
validationContextValidation context
Returns
Validation Result

◆ Equals() [1/2]

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

Returns true if ClassActionEvent instances are equal

Parameters
inputInstance of ClassActionEvent to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if objects are equal

Parameters
inputObject to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnnouncementDate

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

Settlement public-announcement or court-approval date.

Settlement public-announcement or court-approval date.

◆ CaseReference

string Lusid.Sdk.Model.ClassActionEvent.CaseReference
getset

Lawsuit or settlement-fund identifier (court case number, fund name). Audit-only.

Lawsuit or settlement-fund identifier (court case number, fund name). Audit-only.

◆ CashOfferElections

List<CashOfferElection> Lusid.Sdk.Model.ClassActionEvent.CashOfferElections
getset

Cash offer elections for this event. Exactly one entry carrying the per-share settlement amount as CashOfferPrice and settlement currency as CashOfferCurrency.

Cash offer elections for this event. Exactly one entry carrying the per-share settlement amount as CashOfferPrice and settlement currency as CashOfferCurrency.

◆ ClassPeriodEnd

DateTimeOffset Lusid.Sdk.Model.ClassActionEvent.ClassPeriodEnd
getset

Upper bound of the eligibility window (inclusive).

Upper bound of the eligibility window (inclusive).

◆ ClassPeriodStart

DateTimeOffset Lusid.Sdk.Model.ClassActionEvent.ClassPeriodStart
getset

Lower bound of the eligibility window (inclusive).

Lower bound of the eligibility window (inclusive).

◆ ExDate

DateTimeOffset? Lusid.Sdk.Model.ClassActionEvent.ExDate
getset

Date from which the security trades without the settlement right. Null for most class actions where no ex date is defined.

Date from which the security trades without the settlement right. Null for most class actions where no ex date is defined.

◆ FilingDeadline

DateTimeOffset Lusid.Sdk.Model.ClassActionEvent.FilingDeadline
getset

Court-set deadline for submitting a proof of claim.

Court-set deadline for submitting a proof of claim.

◆ LapseElections

List<LapseElection> Lusid.Sdk.Model.ClassActionEvent.LapseElections
getset

Lapse elections for this event. Exactly one entry (NOAC) with IsDefault &#x3D; true.

Lapse elections for this event. Exactly one entry (NOAC) with IsDefault &#x3D; true.

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.ClassActionEvent.PaymentDate
getset

Date on which the settlement distribution is paid to the holder.

Date on which the settlement distribution is paid to the holder.

◆ RecordDate

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

Date at which positions are struck for notification scope. Informational only.

Date at which positions are struck for notification scope. Informational only.


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