A 'transition' within a corporate action, representing a set of output movements paired to a single input position More...

Inheritance diagram for Lusid.Sdk.Model.TransitionEvent:

[legend]

Public Member Functions
	TransitionEvent (DateTimeOffset announcementDate=default(DateTimeOffset), DateTimeOffset exDate=default(DateTimeOffset), DateTimeOffset recordDate=default(DateTimeOffset), DateTimeOffset paymentDate=default(DateTimeOffset), InputTransition inputTransition=default(InputTransition), List< OutputTransition > outputTransitions=default(List< OutputTransition >), InstrumentEventTypeEnum instrumentEventType=default(InstrumentEventTypeEnum))
	Initializes a new instance of the TransitionEvent 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 (TransitionEvent input)
	Returns true if TransitionEvent 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
	TransitionEvent ()
	Initializes a new instance of the TransitionEvent 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]`
	The announcement date of the corporate action More...

DateTimeOffset	ExDate `[get, set]`
	The ex date of the corporate action More...

DateTimeOffset	RecordDate `[get, set]`
	The record date of the corporate action More...

DateTimeOffset	PaymentDate `[get, set]`
	The payment date of the corporate action More...

InputTransition	InputTransition `[get, set]`
	Gets or Sets InputTransition More...

List< OutputTransition >	OutputTransitions `[get, set]`
	The resulting transitions from this event 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 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 }
	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...

Detailed Description

A 'transition' within a corporate action, representing a set of output movements paired to a single input position

Constructor & Destructor Documentation

◆ TransitionEvent() [1/2]

Lusid.Sdk.Model.TransitionEvent.TransitionEvent ( )

inlineprotected

Initializes a new instance of the TransitionEvent class.

◆ TransitionEvent() [2/2]

Lusid.Sdk.Model.TransitionEvent.TransitionEvent	(	DateTimeOffset	announcementDate = `default(DateTimeOffset)`,
		DateTimeOffset	exDate = `default(DateTimeOffset)`,
		DateTimeOffset	recordDate = `default(DateTimeOffset)`,
		DateTimeOffset	paymentDate = `default(DateTimeOffset)`,
		InputTransition	inputTransition = `default(InputTransition)`,
		List< OutputTransition >	outputTransitions = `default(List<OutputTransition>)`,
		InstrumentEventTypeEnum	instrumentEventType = `default(InstrumentEventTypeEnum)`
	)

inline

Initializes a new instance of the TransitionEvent class.

Parameters

announcementDate	The announcement date of the corporate action.
exDate	The ex date of the corporate action.
recordDate	The record date of the corporate action.
paymentDate	The payment date of the corporate action.
inputTransition	inputTransition.
outputTransitions	The resulting transitions from this event.
instrumentEventType	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 (required) (default to "TransitionEvent").

Member Function Documentation

◆ BaseValidate()

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

inlineprotected

To validate all properties of the instance

Parameters

validationContext Validation context

Returns: Validation Result

◆ Equals() [1/2]

override bool Lusid.Sdk.Model.TransitionEvent.Equals ( object input )

inline

Returns true if objects are equal

Parameters

input Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool Lusid.Sdk.Model.TransitionEvent.Equals ( TransitionEvent input )

inline

Returns true if TransitionEvent instances are equal

Parameters

input Instance of TransitionEvent to be compared

Returns: Boolean

◆ GetHashCode()

override int Lusid.Sdk.Model.TransitionEvent.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnnouncementDate

DateTimeOffset Lusid.Sdk.Model.TransitionEvent.AnnouncementDate

getset

The announcement date of the corporate action

◆ ExDate

DateTimeOffset Lusid.Sdk.Model.TransitionEvent.ExDate

getset

The ex date of the corporate action

◆ InputTransition

InputTransition Lusid.Sdk.Model.TransitionEvent.InputTransition

getset

Gets or Sets InputTransition

◆ OutputTransitions

List<OutputTransition> Lusid.Sdk.Model.TransitionEvent.OutputTransitions

getset

The resulting transitions from this event

◆ PaymentDate

DateTimeOffset Lusid.Sdk.Model.TransitionEvent.PaymentDate

getset

The payment date of the corporate action

◆ RecordDate

DateTimeOffset Lusid.Sdk.Model.TransitionEvent.RecordDate

getset

The record date of the corporate action

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Model/TransitionEvent.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TransitionEvent() [1/2]

◆ TransitionEvent() [2/2]

Member Function Documentation

◆ BaseValidate()

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnnouncementDate

◆ ExDate

◆ InputTransition

◆ OutputTransitions

◆ PaymentDate

◆ RecordDate